api reference: update docstrings #142
Merged
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
update some docstrings for clarity. currently, we rely on manual process to python3 generate_api_reference.py and paste it on readme.
agamble-quora
approved these changes
Jan 28, 2025
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.
update some docstrings for clarity.
for reference, our current way of updating https://creator.poe.com/docs/fastapi_poe-python-reference is:
pip3 install -e .python3 generate_api_reference.pythe above steps are documented in docs/generate_api_reference.py, but it seems like this is tedious/easy to forget. We should invest some time to automate this so the reference does not fall behind.