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

Better docstring checking #787

Open
bw4sz opened this issue Sep 19, 2024 · 1 comment
Open

Better docstring checking #787

bw4sz opened this issue Sep 19, 2024 · 1 comment
Assignees

Comments

@bw4sz
Copy link
Collaborator

bw4sz commented Sep 19, 2024

Pretty frequently I find that the docstrings are malformed and sphinx doesn't convert them quite right.

Here is an example

https://deepforest.readthedocs.io/en/latest/_modules/deepforest/utilities.html#crop_raster

Screenshot 2024-09-19 at 12 40 46 PM I think for example here, there needs to be a carriage return? Not sure what the issue is. More broadly, I know we run docformatter, is there something else that needs to happen to get the style here better maintained?
@bw4sz
Copy link
Collaborator Author

bw4sz commented Sep 19, 2024

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

No branches or pull requests

2 participants