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.

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

Check Docstrings Exist #1029

Closed
wants to merge 1 commit into from
Closed

Check Docstrings Exist #1029

wants to merge 1 commit into from

Conversation

pauladkisson
Copy link
Member

Fixes #284 pt 2

Awaiting catalystneuro/.github#19

Copy link
Collaborator

@h-mayorquin h-mayorquin left a comment

Choose a reason for hiding this comment

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

Oh, taking a look at the referenced PR.

uses: catalystneuro/.github/.github/actions/check_docstrings@main
with:
python-version: '3.10'
repository: 'catalystneuro/neuroconv'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you use the ${{github.repository}} context?

@h-mayorquin
Copy link
Collaborator

Question:
@CodyCBakerPhD @pauladkisson

Would having all of the following linter rules in ruff enabled be equivalent to this:
image

https://docs.astral.sh/ruff/rules/#pydocstyle-d

@pauladkisson
Copy link
Member Author

Yes, I think using ruff with skips makes this PR obsolete.

@pauladkisson pauladkisson deleted the docstrings_exist branch September 4, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Testing]: check docstrings for consistency
2 participants