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

feat: Added ReST and Google Style Docstring support#116

Merged
lars-reimann merged 15 commits intomainfrom
18-19-ReST-and-Google-docstring-support
Jun 22, 2023
Merged

feat: Added ReST and Google Style Docstring support#116
lars-reimann merged 15 commits intomainfrom
18-19-ReST-and-Google-docstring-support

Conversation

@Masara
Copy link
Contributor

@Masara Masara commented May 18, 2023

Closes #18.
Closes #19.

Summary of Changes

Added docstring parser for ReST and Google Style Docstrings.

@Masara Masara requested a review from a team as a code owner May 18, 2023 15:22
@Masara Masara changed the title Added ReST and Google Style Docstring support feat: Added ReST and Google Style Docstring support May 18, 2023
@lars-reimann
Copy link
Member

lars-reimann commented May 18, 2023

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ PYTHON black 10 0 0 0.86s
✅ PYTHON mypy 10 0 1.94s
✅ PYTHON ruff 10 0 0 0.02s
✅ REPOSITORY git_diff yes no 0.0s

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

@codecov
Copy link

codecov bot commented May 23, 2023

Codecov Report

Merging #116 (2579edf) into main (6851d07) will increase coverage by 0.12%.
The diff coverage is 94.53%.

@@            Coverage Diff             @@
##             main     #116      +/-   ##
==========================================
+ Coverage   90.48%   90.61%   +0.12%     
==========================================
  Files          84       86       +2     
  Lines        4371     4495     +124     
==========================================
+ Hits         3955     4073     +118     
- Misses        416      422       +6     
Impacted Files Coverage Δ
.../library_analyzer/processing/api/model/__init__.py 100.00% <ø> (ø)
.../api/docstring_parsing/_create_docstring_parser.py 77.77% <62.50%> (-5.56%) ⬇️
...ibrary_analyzer/processing/api/model/_docstring.py 92.15% <80.00%> (-2.97%) ⬇️
...rocessing/api/docstring_parsing/_restdoc_parser.py 97.67% <97.67%> (ø)
...cessing/api/docstring_parsing/_googledoc_parser.py 98.14% <98.14%> (ø)
...lyzer/processing/api/docstring_parsing/__init__.py 100.00% <100.00%> (ø)
...ocessing/api/docstring_parsing/_docstring_style.py 87.50% <100.00%> (+1.78%) ⬆️
src/library_analyzer/processing/api/model/_api.py 94.85% <100.00%> (+0.11%) ⬆️

lukarade
lukarade previously approved these changes Jun 16, 2023
Copy link
Contributor

@lukarade lukarade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

@lars-reimann lars-reimann merged commit 25a3254 into main Jun 22, 2023
@lars-reimann lars-reimann deleted the 18-19-ReST-and-Google-docstring-support branch June 22, 2023 12:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support Google docstrings Support reStructuredText docstrings

4 participants