Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API reference docs problems #234

Open
1 of 3 tasks
Kircheneer opened this issue Jun 22, 2023 · 1 comment
Open
1 of 3 tasks

API reference docs problems #234

Kircheneer opened this issue Jun 22, 2023 · 1 comment
Labels
status: gathering feedback Further discussion is needed to determine this issue's scope and/or implementation type: documentation

Comments

@Kircheneer
Copy link
Collaborator

Kircheneer commented Jun 22, 2023

I see a couple of problems with the API docs:

  • The API reference wraps in the middle of the page
  • Code snippets don't use monospace
  • Not all return types exist in the function signature and sometimes they are manually added in the docstring (Type hinting overhaul. #219)
@Kircheneer Kircheneer added status: gathering feedback Further discussion is needed to determine this issue's scope and/or implementation type: documentation labels Jun 22, 2023
@cardoe
Copy link

cardoe commented Nov 6, 2023

The docs reference _identifiers, _shortname, and _attributes as lists (see: https://diffsync.readthedocs.io/en/latest/getting_started/index.html#define-your-model-with-diffsyncmodel) but they're actually implemented as tuples. But then when you read how they're used, you really want them to be sets (maybe ordered sets if you really want to preserve that order).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: gathering feedback Further discussion is needed to determine this issue's scope and/or implementation type: documentation
Projects
None yet
Development

No branches or pull requests

2 participants