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

Fix placeholder rst hook bugs #365

Merged
merged 22 commits into from
Aug 6, 2024
Merged

Fix placeholder rst hook bugs #365

merged 22 commits into from
Aug 6, 2024

Conversation

dylanhmorris
Copy link
Collaborator

Closes #364 but does not resolve this, which will require a larger rethink of the hook script:

It might also be nice to update the hook so that it fails if the.rst files exist but are not identical to the expected placeholders.

Copy link

codecov bot commented Aug 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.24%. Comparing base (ba30553) to head (9127df3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #365   +/-   ##
=======================================
  Coverage   93.24%   93.24%           
=======================================
  Files          39       39           
  Lines         918      918           
=======================================
  Hits          856      856           
  Misses         62       62           
Flag Coverage Δ
unittests 93.24% <ø> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@gvegayon gvegayon left a comment

Choose a reason for hiding this comment

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

Mostly one comment about counting changes when RSTs are removed. Before closing/merging this, I would also create a separate issue for improving this whole process (compare expected vs observed RST).

hook_scripts/pre-commit-rst-placeholder.sh Show resolved Hide resolved
docs/source/tutorials/.gitignore Show resolved Hide resolved
Copy link
Member

@gvegayon gvegayon left a comment

Choose a reason for hiding this comment

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

LGTM

@gvegayon gvegayon merged commit 06b66da into main Aug 6, 2024
9 checks passed
@gvegayon gvegayon deleted the dhm-fix-placeholder-bug branch August 6, 2024 15:56
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.

Update .rst placeholder generation
2 participants