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

feat: Classify functions into categories and search functionality #41

Merged
merged 5 commits into from
Jan 3, 2024

Conversation

sanjibansg
Copy link
Contributor

@sanjibansg sanjibansg commented Dec 25, 2023

This PR modifies the function index page to have structured categories for various functions and adds search functionality.

This should resolve #40

Copy link
Member

@richtia richtia left a comment

Choose a reason for hiding this comment

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

Thanks for making these updates!

Here are a few suggestion for the overall site that would be nice.

  • Would it be possible to have the search functionality prioritize function names before looking through the description test message? For example if you search for or, it'll show lots of functions that have that word first.
  • Search results don't go away when you click on other function categories. Maybe it makes more sense to clear the search if a different function category on the left pane or home is clicked on.
  • Seems like the home button doesn't really work anymore after you've made a search?

This might make sense to have in a separate PR:

  • Can the actual function site redirection be displayed in the same scheme as the index? Instead of it looking like it's taking you to a different website entirely?

@sanjibansg sanjibansg force-pushed the function-classification branch from 88e8c79 to d7382b8 Compare January 1, 2024 09:12

This comment was marked as resolved.

@sanjibansg sanjibansg force-pushed the function-classification branch from d7382b8 to 66c63a3 Compare January 1, 2024 09:18
@sanjibansg sanjibansg force-pushed the function-classification branch from 66c63a3 to 517cffa Compare January 1, 2024 09:46
@sanjibansg sanjibansg requested a review from richtia January 1, 2024 09:47
Copy link
Member

@richtia richtia left a comment

Choose a reason for hiding this comment

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

Thanks for making the fixes. I just noticed is that the search results have the function category prepended to the function name. I think it came as part of my change previously to allow for duplicate function names to be displayed. Can we fix those search results to only have the function name. The category is displaying right over it, so it's not needed. For some reason comparison functions like and and or can't be searched for properly. They're likely some type of reserved word, can you look into that?

@sanjibansg sanjibansg requested a review from richtia January 2, 2024 06:12
@sanjibansg
Copy link
Contributor Author

Thanks for making the fixes. I just noticed is that the search results have the function category prepended to the function name. I think it came as part of my change previously to allow for duplicate function names to be displayed. Can we fix those search results to only have the function name. The category is displaying right over it, so it's not needed. For some reason comparison functions like and and or can't be searched for properly. They're likely some type of reserved word, can you look into that?

Fixed the function category being prepended to the names in the search results. This should improve the search results as well. Could you please confirm?

@richtia
Copy link
Member

richtia commented Jan 2, 2024

Thanks for making the fixes. I just noticed is that the search results have the function category prepended to the function name. I think it came as part of my change previously to allow for duplicate function names to be displayed. Can we fix those search results to only have the function name. The category is displaying right over it, so it's not needed. For some reason comparison functions like and and or can't be searched for properly. They're likely some type of reserved word, can you look into that?

Fixed the function category being prepended to the names in the search results. This should improve the search results as well. Could you please confirm?

Looks like the update you made removed the prepended category from the function name in the search results. But it also removed the prepended part from the resulting URL. So it redirects to a page that doesn't exist. We don't want to see the prepended category in the search result, but it's still needed in the page redirect.

@sanjibansg
Copy link
Contributor Author

Thanks for making the fixes. I just noticed is that the search results have the function category prepended to the function name. I think it came as part of my change previously to allow for duplicate function names to be displayed. Can we fix those search results to only have the function name. The category is displaying right over it, so it's not needed. For some reason comparison functions like and and or can't be searched for properly. They're likely some type of reserved word, can you look into that?

Fixed the function category being prepended to the names in the search results. This should improve the search results as well. Could you please confirm?

Looks like the update you made removed the prepended category from the function name in the search results. But it also removed the prepended part from the resulting URL. So it redirects to a page that doesn't exist. We don't want to see the prepended category in the search result, but it's still needed in the page redirect.

ah yes, thanks for the catch! fixed it.

build_site.py Outdated Show resolved Hide resolved
@sanjibansg sanjibansg requested a review from richtia January 3, 2024 08:51
@richtia richtia merged commit 4fd4c3d into main Jan 3, 2024
7 checks passed
@sanjibansg sanjibansg deleted the function-classification branch January 3, 2024 14:45
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.

Classify functions into categories
2 participants