Skip to content
This repository has been archived by the owner on Nov 23, 2024. It is now read-only.

feat: parse docstrings in the epydoc format #82

Merged
merged 6 commits into from
Apr 3, 2023
Merged

feat: parse docstrings in the epydoc format #82

merged 6 commits into from
Apr 3, 2023

Conversation

lars-reimann
Copy link
Member

@lars-reimann lars-reimann commented Apr 3, 2023 •
edited
Loading

Closes #16.
Closes #17.

Summary of Changes

  • Parse docstrings in the epydoc format
  • Add a flag to the CLI to choose the docstring format (supports the settings plaintext, numpy and epydoc at the moment)
  • Refactor the parser for Numpydoc to use the docstring_parser

@lars-reimann lars-reimann requested a review from a team as a code owner April 3, 2023 17:54
@lars-reimann lars-reimann linked an issue Apr 3, 2023 that may be closed by this pull request
Support common documentation formats #14
Closed
7 tasks
@lars-reimann
Copy link
Member Author

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ PYTHON black 38 0 0 2.59s
✅ PYTHON mypy 38 0 5.66s
✅ PYTHON ruff 38 0 0 0.11s
✅ REPOSITORY git_diff yes no 0.06s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@lars-reimann lars-reimann merged commit 1fdab33 into main Apr 3, 2023
@lars-reimann lars-reimann deleted the 14-support-common-documentation-formats branch April 3, 2023 17:59
@lars-reimann lars-reimann removed a link to an issue Apr 3, 2023
Support common documentation formats #14
Closed
7 tasks
This was referenced Apr 3, 2023
Closed
Open
Merged
lars-reimann added a commit that referenced this pull request Apr 3, 2023
@lars-reimann
feat: store full_docstring of classes and functions again (#87)
a28393b 
Closes #83.

### Summary of Changes

Store the full docstring of classes and functions again in the created
docstring. This was removed in #82.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support epytext docstrings Flag to choose between different documentation formats
1 participant
@lars-reimann