Optimize the documentation JS files #20075
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jchyb
requested changes
Apr 3, 2024
There was a problem hiding this comment.
Hi @RedYetiDev! I should mention now that I am very far from the .js expert, so I may not be up-to-date on the features, or more importantly, the convention used for js code (like which function syntax should be used/is more popular). With that said I'm going to look at this from the scala perspective. Also since the bulk of the changes are concerning syntax changes without any performance improvements, I'm going to be a bit more picky with those (apologies in advance!).
|
Once the changes are approved, If you'd like, I'll squash before merging |
|
Okay, would you like me to squash before we merge? |
|
That's not necessary, I can squash while merging using GitHub UI |
|
Sounds good! |
jchyb
approved these changes
Apr 4, 2024
WojciechMazur
pushed a commit
that referenced
this pull request
Jul 4, 2024
This PR optimizes the three files in the `/docs/_assets/js` directory
for performance.
In `toolbar.js`, jQuery selectors have been cached as variables to
prevent constant calls to the DOM.
In `sidebar.js`, the multiple `toggleClass(...).toggleClass(...)` have
been merged into one
In `api-search.js`:
- Defined functions have been switched to newer ES format (`const myFunc
= () => {}`)
- JSON has been switched to **JS**ON (`{"key":"value"}` ->
`{key:"value"}`)
[Cherry-picked fa2f7bf]
WojciechMazur
added a commit
that referenced
this pull request
Jul 5, 2024
Backports #20075 to the LTS branch. PR submitted by the release tooling. [skip ci]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR optimizes the three files in the
/docs/_assets/jsdirectory for performance.In
toolbar.js, jQuery selectors have been cached as variables to prevent constant calls to the DOM.In
sidebar.js, the multipletoggleClass(...).toggleClass(...)have been merged into oneIn
api-search.js:const myFunc = () => {})regexForTermhas been switched to ternary{"key":"value"}->{key:"value"})