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

fix: Purity analysis Docstrings#204

Merged
lars-reimann merged 306 commits intomainfrom
purity-analysis-docs-remastered
Jan 12, 2024
Merged

fix: Purity analysis Docstrings#204
lars-reimann merged 306 commits intomainfrom
purity-analysis-docs-remastered

Conversation

@lukarade
Copy link
Copy Markdown
Contributor

@lukarade lukarade commented Jan 1, 2024

Summary of Changes

  • Fixed existing Docstrings to follow the numbydoc style guide
  • Added all missing Docstrings for all classes and functions

Only merge after #203

lukarade and others added 30 commits May 26, 2023 16:57
…ariables

# Conflicts:
#	src/library_analyzer/processing/api/__init__.py
#	src/library_analyzer/processing/api/_resolve_references.py
#	tests/library_analyzer/processing/api/test_resolve_references.py
# Conflicts:
#	src/library_analyzer/processing/api/__init__.py
#	src/library_analyzer/processing/api/_resolve_references.py
#	tests/library_analyzer/processing/api/test_resolve_references.py
…nto resolve-references_new

# Conflicts:
#	src/library_analyzer/processing/api/__init__.py
#	src/library_analyzer/processing/api/_resolve_references.py
#	tests/library_analyzer/processing/api/test_resolve_references.py
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 1, 2024

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ PYTHON black 10 0 0 1.46s
✅ PYTHON mypy 10 0 2.32s
✅ PYTHON ruff 10 0 0 0.06s
✅ REPOSITORY git_diff yes no 0.03s

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
Copy Markdown

codecov bot commented Jan 1, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (90f8ac8) 92.99% compared to head (c6d83e3) 92.92%.

Files Patch % Lines
...er/processing/api/purity_analysis/model/_purity.py 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #204      +/-   ##
==========================================
- Coverage   92.99%   92.92%   -0.07%     
==========================================
  Files          96       96              
  Lines        6122     6123       +1     
==========================================
- Hits         5693     5690       -3     
- Misses        429      433       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lukarade lukarade self-assigned this Jan 2, 2024
@lukarade lukarade marked this pull request as ready for review January 2, 2024 14:15
@lukarade lukarade requested a review from a team as a code owner January 2, 2024 14:15
@lukarade lukarade added the purity Inferring the purity of functions label Jan 2, 2024
@lars-reimann lars-reimann marked this pull request as draft January 9, 2024 15:19
lukarade and others added 6 commits January 11, 2024 20:55
# Conflicts:
#	src/library_analyzer/processing/api/purity_analysis/_build_call_graph.py
#	src/library_analyzer/processing/api/purity_analysis/_get_module_data.py
#	src/library_analyzer/processing/api/purity_analysis/_infer_purity.py
#	src/library_analyzer/processing/api/purity_analysis/_resolve_references.py
#	src/library_analyzer/processing/api/purity_analysis/model/_purity.py
#	src/library_analyzer/processing/api/purity_analysis/model/_reference.py
#	src/library_analyzer/processing/api/purity_analysis/model/_scope.py
#	tests/library_analyzer/processing/api/test_get_module_data.py
#	tests/library_analyzer/processing/api/test_infer_purity.py
#	tests/library_analyzer/processing/api/test_resolve_references.py
@lukarade lukarade marked this pull request as ready for review January 11, 2024 22:36
Copy link
Copy Markdown
Member

@lars-reimann lars-reimann left a comment

Choose a reason for hiding this comment

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

Nice, thank you!

@lars-reimann lars-reimann merged commit 4018728 into main Jan 12, 2024
@lars-reimann lars-reimann deleted the purity-analysis-docs-remastered branch January 12, 2024 09:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

purity Inferring the purity of functions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants