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 codeautolink_warn_on_no_backreference config #163

Merged
merged 2 commits into from
Feb 11, 2025

Conversation

cmarqu
Copy link
Contributor

@cmarqu cmarqu commented Feb 9, 2025

Highlights where reference documentation does not have a corresponding tutorial or how-to

Closes #161

  • Tests written and passed
  • Documentation and changelog entry written, docs build passed
  • All tox checks passed

@cmarqu
Copy link
Contributor Author

cmarqu commented Feb 9, 2025

@felix-hilden I could not easily figure out how a test would need to be written. Feel free to push to this PR directly.

@felix-hilden
Copy link
Owner

felix-hilden commented Feb 10, 2025

I think we should be able to write a test where we inject the refs but have no code examples. For example: https://github.com/felix-hilden/sphinx-codeautolink/blob/master/tests/extension/fail/missing_inventory.txt

@cmarqu cmarqu force-pushed the feat/warn-no-backref branch from 360eef4 to 2b29866 Compare February 10, 2025 19:40
@cmarqu
Copy link
Contributor Author

cmarqu commented Feb 10, 2025

I think we should be able to write a test where we inject the refs but have no code examples. For example: https://github.com/felix-hilden/sphinx-codeautolink/blob/master/tests/extension/fail/missing_inventory.txt

Ah yes, I was wondering how the check is done, but I get it now - because the test is in the fail/ directory, it's automatically expected to fail, and if I only set the codeautolink_warn_on_no_backreference = True config option, I am not accidentally checking the wrong fail.

@felix-hilden
Copy link
Owner

Code looks good now!

  • feel free to add the lint failure to the extend-ignore, seems useless
  • please rebase for the release notes
  • let's call this 0.17, you've submitted nice additions! 🎉

Highlights where reference documentation does not have a corresponding tutorial or how-to

Closes felix-hilden#161
@cmarqu cmarqu force-pushed the feat/warn-no-backref branch from 9c65c07 to a4549b3 Compare February 11, 2025 16:47
@cmarqu
Copy link
Contributor Author

cmarqu commented Feb 11, 2025

Seems to work fine now.

@felix-hilden felix-hilden merged commit 315d1e8 into felix-hilden:master Feb 11, 2025
4 checks passed
@cmarqu cmarqu deleted the feat/warn-no-backref branch February 12, 2025 06:26
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.

Log when .. autolink-examples:: removes an empty table to point to missing code examples
2 participants