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

Correct file-docstrings not matching file names #1770

Merged
merged 1 commit into from
Aug 23, 2023

Conversation

gbfredrik
Copy link
Contributor

Hi!
I ran a check to find docstrings with incorrect file name references, hopefully this makes things clearer.

@coveralls
Copy link

Coverage Status

coverage: 71.905%. remained the same when pulling 87713cb on Model-Validation:docstring-fixes into d4e39d8 on lballabio:master.

@lballabio
Copy link
Owner

Thanks, Fredrik. Do you have the check available as a script? If so, we can add it to the CI builds.

@lballabio lballabio added this to the Release 1.32 milestone Aug 19, 2023
@gbfredrik
Copy link
Contributor Author

Yes! This is what I used: find ql -type f -name "*.hpp" -exec sh -c 'grep -L "$(basename {} .hpp)" {}' \;

The command also lists files missing the \file comment, which you may or may not want to identify.

@lballabio
Copy link
Owner

Thanks! I'll try to list just those with a wrong \file entry, there might be a few reasons it might be missing.

@lballabio lballabio merged commit 4c9ccc3 into lballabio:master Aug 23, 2023
48 checks passed
@gbfredrik gbfredrik deleted the docstring-fixes branch January 16, 2024 17:58
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.

3 participants