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

Add docs label for markdown files #657

Merged
merged 3 commits into from
Dec 11, 2024
Merged

Conversation

skirpichev
Copy link
Member

Closes #656

Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (0ab7f2c) to head (f2c98b6).
Report is 2 commits behind head on main.

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #657   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           18        18           
  Lines         2149      2149           
  Branches        97        97           
=========================================
  Hits          2149      2149           
Flag Coverage Δ
Python_3.10.15 100.00% <100.00%> (ø)
Python_3.11.10 100.00% <100.00%> (ø)
Python_3.12.7 100.00% <100.00%> (ø)
Python_3.13.0 ?
Python_3.13.1 100.00% <100.00%> (?)
Python_3.9.20 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
bedevere/prtype.py 100.00% <100.00%> (ø)
tests/test_prtype.py 100.00% <100.00%> (ø)

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks!

bedevere/prtype.py Outdated Show resolved Hide resolved
Co-authored-by: Hugo van Kemenade <[email protected]>
bedevere/prtype.py Outdated Show resolved Hide resolved
@AA-Turner AA-Turner changed the title Add docs label for *.md files Add docs label for markdown files Dec 8, 2024
Co-authored-by: Adam Turner <[email protected]>
@@ -66,7 +66,7 @@ async def test_news_only():


async def test_docs_no_news():
filenames = {"path/to/docs1.rst"}
filenames = {"path/to/docs1.rst", "other/path/to/docs2.md"}
Copy link
Member

Choose a reason for hiding this comment

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

Wouldn't this test pass even without the changes in prtype.py?
The filenames include an .rst file, so the docs label should be applied regardless.
I would suggest to verify this, and possibly turn the list of filenames into a fixture.

Copy link
Member Author

Choose a reason for hiding this comment

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

Wouldn't this test pass even without the changes in prtype.py?

No. In this case classify_by_filepaths() will quickly return an empty list, walking over filenames (else branch).

@hugovk hugovk merged commit f26f464 into python:main Dec 11, 2024
9 checks passed
@skirpichev skirpichev deleted the md-docs/656 branch December 11, 2024 06:38
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.

Treat InternalDocs/* like Docs/*?
4 participants