Remove unwanted members from API documentation #85
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
melissawm
added a commit
to melissawm/acquire-python
that referenced
this pull request
Aug 15, 2024
aliddell
reviewed
Aug 21, 2024
mkdocs.yml
Outdated
| members_order: "alphabetical" | ||
| filters: ["!^_", "!dict"] # Remove private members | ||
| filters: ["!^_", "!dict", "!setup_", "!gui"] # Remove private members |
There was a problem hiding this comment.
My understanding is we wanted to remove the setup_one_streams and setup_two_streams functions - is that not right?
dgmccart
approved these changes
Sep 4, 2024
dgmccart
pushed a commit
to acquire-project/acquire-python
that referenced
this pull request
Sep 4, 2024
Follow-up to acquire-project/acquire-docs#85 Adding a docstring makes sure this object is visible in the autogenerated API docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Removes documentation for acquire functions except for core_api_version and setup (the latter is cited in one of the tutorials).
For core_api_version, I will follow up with a PR to acquire-python to add a docstring, otherwise it won't be shown.