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

Search bar improvments and Help page #823

Merged
merged 21 commits into from
Nov 26, 2024

Conversation

tristanlatr
Copy link
Contributor

@tristanlatr tristanlatr commented Oct 4, 2024

Implement one idea described in #822, more specifically:

  • add a leading wildcard to the query when the term contains a dot ".".

Fixes #819

Other changes:

  • Move the NotFoundLinker to the linker.oy module because t's now used by the help page renderer.
  • Simplify the readthedocs theme and fix an issue that prevented to use the search bar from the module index page and other summary pages.

This comment has been minimized.

This comment has been minimized.

@tristanlatr
Copy link
Contributor Author

This could be a good opportunity to fix the search bar with the readthedocs in the summary pages. Which is simply not working at the moment :/

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

1 similar comment

This comment has been minimized.

Copy link

codecov bot commented Nov 21, 2024

Codecov Report

Attention: Patch coverage is 96.29630% with 1 line in your changes missing coverage. Please review.

Project coverage is 92.30%. Comparing base (ad1fc12) to head (60cb87c).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
pydoctor/linker.py 87.50% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #823      +/-   ##
==========================================
+ Coverage   92.29%   92.30%   +0.01%     
==========================================
  Files          47       47              
  Lines        8514     8540      +26     
  Branches     1695     1696       +1     
==========================================
+ Hits         7858     7883      +25     
- Misses        385      386       +1     
  Partials      271      271              

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

This comment has been minimized.

1 similar comment

This comment has been minimized.

This comment has been minimized.

1 similar comment

This comment has been minimized.

…r could be impredictible and this is somewhat hacky.

Eventually I think the search bar should only display the ~20 first items and propose to load more if the expected entry is not found.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

1 similar comment

This comment has been minimized.

This comment has been minimized.

@tristanlatr
Copy link
Contributor Author

This PR is ready to be merged.

Copy link

According to pydoctor_primer, this change doesn't affect pydoctor warnings on a corpus of open source code. ✅

@tristanlatr tristanlatr merged commit 26cbc91 into master Nov 26, 2024
41 checks passed
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.

Create a bundled "how to use pydoctor" help page
1 participant