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

[DOC] Added search functionality for estimator overview table #2496

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

kavya-r30
Copy link
Contributor

Reference Issues/PRs

Fixes #1438

What does this implement/fix? Explain your changes.

Added search functionality and page sorting for estimator overview table
image
image

Does your contribution introduce a new dependency? If yes, which one?

No

Any other comments?

@all-contributors please add @kavya-r30 for code

PR checklist

For all contributions
  • I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
  • The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.
For new estimators and functions
  • I've added the estimator/function to the online API documentation.
  • (OPTIONAL) I've added myself as a __maintainer__ at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.
For developers with write access
  • (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run mypy typecheck tests
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Push an empty commit to re-run CI checks

@baraline baraline changed the title Added search functionality for estimator overview table [DOC] Added search functionality for estimator overview table Jan 13, 2025
@baraline
Copy link
Member

Hey, thanks for working on this.

I'm not getting the same results on my side (with firefox and edge, same results). Anyone else can confirm ?

Capture d'écran 2025-01-13 221207

@SebastianSchmidl
Copy link
Member

Hey, thanks for working on this.

I'm not getting the same results on my side (with firefox and edge, same results). Anyone else can confirm ?

Capture d'écran 2025-01-13 221207

I can confirm, the RDT-build does not produce the expected results.

@SebastianSchmidl SebastianSchmidl added documentation Improvements or additions to documentation enhancement New feature, improvement request or other non-bug code enhancement labels Jan 14, 2025
@SebastianSchmidl SebastianSchmidl marked this pull request as draft January 14, 2025 09:41
@kavya-r30
Copy link
Contributor Author

@baraline @SebastianSchmidl
Could check the build now it seems that the issue is fixed and now I'm able to see and search using search bar
Also is the pre commit thingy because of the spaces?

@baraline
Copy link
Member

baraline commented Jan 14, 2025

Great job, search is working great ! Only thing left to correct would be to adapt the table style to the dark/light mode toggle, currently, it displays only as light theme even with dark mode on.

For pre-commit, I would suggest you install it locally using the dev documentation, it will be way easier to see and fix the issues this way. It can even fix some issues automatically when you try to commit (you need to re-add and commit if some fixes have been auto applied), it will also tell you errors and what to do to fix them

@kavya-r30
Copy link
Contributor Author

Thank you for the feedback! I will look into adapting the table style to the dark/light mode toggle so that it displays correctly in both themes as well as try pre commit.

@SebastianSchmidl
Copy link
Member

SebastianSchmidl commented Jan 14, 2025

For me, the dark/light mode works as expected:

estimator-overview

  • OS: Kubuntu 22.04
  • Browsers:
    • Vivaldi 7.0.3495.27
    • Firefox 134.0 (switches automatically to dark mode because this is my system default)
    • Google Chrome 131.0.6778.204

The search is also really nice 👍🏼 🥳


I have some additional requests (unrelated to the search):

  • Could we restrict the page size to something that fits on a standard screen per default? Currently, you need to scroll the table vertically and also switch pages. (or change the page size with the drop-down)
  • The table is, unfortunately, too large for the current main-div-width. I would like to not need to scroll horizontally to see all tags. I have no idea how we could achieve this.

This does not need to be fixed in this PR. But, do you have any idea how to deal with it?

@SebastianSchmidl SebastianSchmidl marked this pull request as ready for review January 14, 2025 16:11
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 enhancement New feature, improvement request or other non-bug code enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add search/sort functionality for estimator overview table.
3 participants