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

Check and fix docstrings #169

Closed
francium opened this issue Dec 23, 2023 · 0 comments
Closed

Check and fix docstrings #169

francium opened this issue Dec 23, 2023 · 0 comments

Comments

@francium
Copy link
Member

francium commented Dec 23, 2023

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",

based on all of the Google-style docstrings in your code

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

No branches or pull requests

1 participant