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

Improve config snippets in code exclusion docs #1917

Merged
merged 2 commits into from
Jan 21, 2025

Conversation

allanlewis
Copy link
Contributor

This PR makes some improvements to the code snippets in the "Excluding code from coverage.py" docs.

"@(abc\\.)?abstractmethod",
]
'class .*\bProtocol\):',
'@(abc\.)?abstractmethod',
Copy link
Owner

Choose a reason for hiding this comment

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

TIL that single- and double-quotes have different semantics. I would rather use single quotes for all strings instead of mixing the styles.

Also, make sure the cog process that produces the files still works properly. You need to run make cogdoc to be sure.

@nedbat
Copy link
Owner

nedbat commented Jan 20, 2025

Thanks. Looks like there are also places in config.rst to fix.

@nedbat
Copy link
Owner

nedbat commented Jan 20, 2025

Or, let me know if you'd like me to take care of that.

@allanlewis
Copy link
Contributor Author

Or, let me know if you'd like me to take care of that.

If you have time, that would be great! Otherwise I'll try to get back to this later in the week.

@allanlewis allanlewis force-pushed the improve-code-exclusion-docs branch from 2a410f5 to 601bc44 Compare January 20, 2025 21:20
@allanlewis
Copy link
Contributor Author

I found some time - the CI commands are passing locally now.

@nedbat
Copy link
Owner

nedbat commented Jan 20, 2025

Thanks. Let me know when you are done with it. Do you want to put all the exclusions in single quotes for consistency?

@allanlewis
Copy link
Contributor Author

Do you want to put all the exclusions in single quotes for consistency?

Sure, I guess that makes sense - whichever of us finds the time first 🙂

@allanlewis allanlewis force-pushed the improve-code-exclusion-docs branch from 601bc44 to a117d88 Compare January 21, 2025 09:49
@allanlewis
Copy link
Contributor Author

Do you want to put all the exclusions in single quotes for consistency?

Sure, I guess that makes sense - whichever of us finds the time first 🙂

Done - GTM?

@nedbat nedbat marked this pull request as ready for review January 21, 2025 10:30
@nedbat nedbat force-pushed the improve-code-exclusion-docs branch from a117d88 to 1ef7cc2 Compare January 21, 2025 10:50
@nedbat nedbat merged commit 4f12504 into nedbat:master Jan 21, 2025
32 checks passed
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.

2 participants