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

Include filter/field options in the documentation #24

Open
multimeric opened this issue Nov 11, 2022 · 1 comment
Open

Include filter/field options in the documentation #24

multimeric opened this issue Nov 11, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@multimeric
Copy link
Owner

The type annotations aren't helpful to those not using an IDE.

@multimeric multimeric added the documentation Improvements or additions to documentation label May 23, 2024
@multimeric
Copy link
Owner Author

This is actually quite a difficult problem. I can transform the auto-generated mkdocstrings docs, but it's not clear if I should:

  • List out all types, which would be comprehensive but unreadable
  • Simplify the top-level literals such as the UniprotKB fields into a single list of options. This is possible, I wrote a transformer that does this, but it's not clear how to present this information. The rest of the docs present data structures in terms of Python code, but "a list of strings" isn't an actual data type we ever work with, in reality it's a type literal
  • Generate docs for the .search method of each dataset client separately, and add the list of options to the docstring. This might be user friendly, but the number of options (sometimes in the hundreds) might get unwieldy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant