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

Ranking statistic documentation fix #5055

Merged
merged 5 commits into from
Feb 26, 2025

Conversation

GarethCabournDavies
Copy link
Contributor

@GarethCabournDavies GarethCabournDavies commented Feb 21, 2025

Shichao noticed that the ranking statistic page wasn't displaying properly, and that the search page just doesn't show anything at all.

The ranking statistic page was broken as there were some unprintable characters (thanks copilot).

The search page looks like it was being overwritten by the search.html being used to actually make the search functionality

Standard information about the request

This is a bug fix
This change changes documentation
This change has been proposed using the contribution guidelines

Contents

Clean up unprintable characters, rename search to searches`

Testing performed

Ranking statistic page now loads properly in the github preview
https://github.com/GarethCabournDavies/pycbc/blob/documentation_fix/docs/searches/ranking_statistic.rst

As opposed to
https://github.com/gwastro/pycbc/blob/dc2bad6/docs/search/ranking_statistic.rst

Search issue is something that I think will not have evidence that it has worked until this is merged

  • The author of this pull request confirms they will adhere to the code of conduct

@GarethCabournDavies GarethCabournDavies added bug documentation Updates to documentation labels Feb 21, 2025
Copy link
Contributor

@WuShichao WuShichao left a comment

Choose a reason for hiding this comment

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

Thanks Gareth! Looks good to me.

@WuShichao WuShichao merged commit 515fa70 into gwastro:master Feb 26, 2025
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Updates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants