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

🐛📝 Fixes and tests links on the doc #188

Merged
merged 4 commits into from
Oct 1, 2024

Conversation

pcrespov
Copy link
Member

@pcrespov pcrespov commented Oct 1, 2024

What do these changes do?

This PR adds tests on doc links/references:

  • adds automatic tests on doc references.
  • manually modified extra wrong links

Related issue/s

How to test

Can manually run as:

pytest clients/python/test/tests_docs.py

@pcrespov pcrespov self-assigned this Oct 1, 2024
@pcrespov pcrespov added the documentation Improvements or additions to documentation label Oct 1, 2024
@pcrespov pcrespov added this to the MartinKippenberger milestone Oct 1, 2024
@pcrespov pcrespov requested a review from calys October 1, 2024 12:06
@pcrespov pcrespov changed the title 🐛📝 Fixes on doc 🐛📝 Fixes and tests links on the doc Oct 1, 2024
@pcrespov pcrespov enabled auto-merge (squash) October 1, 2024 12:06
Copy link

@calys calys left a comment

Choose a reason for hiding this comment

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

I can't comment on whether this PR works, but it's good to know that some tests are put in place so that links don't end up broken so easily. 👍

@pcrespov pcrespov disabled auto-merge October 1, 2024 12:43
@pcrespov pcrespov merged commit 7cbf7a1 into ITISFoundation:master Oct 1, 2024
8 checks passed
@pcrespov pcrespov deleted the mai/enh-doc branch October 1, 2024 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants