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.

Sign up for GitHub

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

Jump to bottom

Fix Returns sections of some docstrings #759

Closed
ascillitoe opened this issue Mar 16, 2023 · 2 comments · Fixed by #789
Closed

Fix Returns sections of some docstrings #759

ascillitoe opened this issue Mar 16, 2023 · 2 comments · Fixed by #789
Assignees
@mauicv
Labels
Type: Docs Anything related to documentation

Comments

@ascillitoe
Copy link
Contributor

In many Returns sections of the API docs, paragraphs are being incorrectly split into bulleted lists, for example:

image

See #677 (comment) for info on causes and fixes.
@ascillitoe ascillitoe added the Type: Docs Anything related to documentation label Mar 16, 2023
@ascillitoe ascillitoe mentioned this issue Mar 16, 2023
Merged
17 tasks
@mauicv mauicv mentioned this issue Mar 17, 2023
Closed
@ascillitoe
Copy link
Contributor Author

Additional context from @mauicv:

Oh, I've actually fixed a bunch of these in #748. I was aware of it as @RobertSamoilescu highlighted the issue in alibi. I had thought the same effort to fix them there had been done in detect but it hasn't yet!

@ascillitoe
Copy link
Contributor Author

Also, the alibi-detect CONTRIBUTING.md could be updated with the revised docstring guidelines added to alibi in SeldonIO/alibi#571.

@mauicv mauicv self-assigned this Mar 17, 2023
@mauicv mauicv mentioned this issue May 15, 2023
Merged
2 tasks
@ascillitoe ascillitoe linked a pull request Jun 12, 2023 that will close this issue
Docstring return statements #789
Merged
2 tasks
@mauicv mauicv closed this as completed Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mauicv mauicv

Labels
Type: Docs Anything related to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docstring return statements mauicv/alibi-detect
Add flake8-docstrings to CI mauicv/alibi-detect
2 participants
@mauicv @ascillitoe