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

Flag to choose between different documentation formats #16

Closed
lars-reimann opened this issue Jul 6, 2022 · 0 comments · Fixed by #82
Closed

Flag to choose between different documentation formats #16

lars-reimann opened this issue Jul 6, 2022 · 0 comments · Fixed by #82
Assignees
@lars-reimann
Labels
enhancement 💡 New feature or request

Comments

@lars-reimann
Copy link
Member

Is your feature request related to a problem?

When running the API command, the user must be able to choose a documentation format.

Desired solution

Add another flag to the API command. By default it should not try to parse the documentation any further.

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

No response
@lars-reimann lars-reimann added the enhancement 💡 New feature or request label Jul 6, 2022
@lars-reimann lars-reimann mentioned this issue Mar 19, 2023
Closed
7 tasks
@lars-reimann lars-reimann self-assigned this Jul 14, 2022
@lars-reimann lars-reimann removed their assignment Feb 10, 2023
@lars-reimann lars-reimann transferred this issue from Safe-DS/API-Editor Mar 19, 2023
@lars-reimann lars-reimann moved this from Backlog to In Progress in Library Analysis Apr 3, 2023
@lars-reimann lars-reimann self-assigned this Apr 3, 2023
@lars-reimann lars-reimann mentioned this issue Apr 3, 2023
Merged
lars-reimann added a commit that referenced this issue Apr 3, 2023
@lars-reimann
feat: parse docstrings in the epydoc format (#82)
1fdab33 
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`
@github-project-automation github-project-automation bot moved this from In Progress to ✔️ Done in Library Analysis Apr 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lars-reimann lars-reimann

Labels
enhancement 💡 New feature or request
Projects
Library Analysis
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: parse docstrings in the epydoc format Safe-DS/Library-Analyzer
1 participant
@lars-reimann