Skip to content

Fixes all docstrings and adds lint for docstrings - #134

Merged
alexhroom merged 5 commits into
RascalSoftware:mainfrom
alexhroom:more-docstrings
Feb 25, 2025
Merged

Fixes all docstrings and adds lint for docstrings#134
alexhroom merged 5 commits into
RascalSoftware:mainfrom
alexhroom:more-docstrings

Conversation

@alexhroom

@alexhroomalexhroom commented Feb 18, 2025

Copy link
Copy Markdown
Collaborator

This PR adds the pydocstyle ruleset to ruff and fixes all docstrings in line with it.

DrPaulSharp
DrPaulSharp approved these changes Feb 25, 2025
View reviewed changes

@DrPaulSharpDrPaulSharp left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Good work on this one. Just a few minor things for you to have a look at.

Comment threadRATapi/classlist.py Outdated
Comment threadRATapi/examples/domains/domains_standard_layers.py
Comment threadRATapi/inputs.py Outdated
Comment threadRATapi/inputs.py Outdated
Comment threadRATapi/project.py Outdated
Comment threadRATapi/utils/enums.py Outdated
Comment threadRATapi/utils/enums.py Outdated
@alexhroom
alexhroom merged commit 147cbee into RascalSoftware:mainFeb 25, 2025
@alexhroom
alexhroom deleted the more-docstrings branch February 25, 2025 14:11
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@DrPaulSharpDrPaulSharpDrPaulSharp approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@alexhroom@DrPaulSharp