We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
After the completion of #153 and #168, there's some docstrings that aren't correctly written and render incorrectly. For example https://github.com/rustedpy/result/blob/master/docs/result.md#function-is_err. We need to figure out how to correctly format the docstrings so docstrings render properly.
Great issue for anyone looking to help out.
The docs are generated using make docs and using https://github.com/ml-tooling/lazydocs. Their readme says they expect "Google-style docstrings",
make docs
https://github.com/ml-tooling/lazydocs
based on all of the Google-style docstrings in your code
The text was updated successfully, but these errors were encountered:
262181b
No branches or pull requests
After the completion of #153 and #168, there's some docstrings that aren't correctly written and render incorrectly. For example https://github.com/rustedpy/result/blob/master/docs/result.md#function-is_err. We need to figure out how to correctly format the docstrings so docstrings render properly.
Great issue for anyone looking to help out.
The docs are generated using
make docs
and usinghttps://github.com/ml-tooling/lazydocs
. Their readme says they expect "Google-style docstrings",The text was updated successfully, but these errors were encountered: