Closed
Conversation
✅ Deploy Preview for oxc-project ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Member
|
@Sheraff You're correct: there is automation that generates the website's documentation directly from the source. This file is autogenerated, so you'll need to update it here directly: https://github.com/oxc-project/oxc/blob/22f18ac144ed79aad0172bf7040d4815dcdf34cc/crates/oxc_linter/src/rules/oxc/bad_min_max_func.rs#L22-L51. The changes will appear on the website with the next oxlint release after it is merged. |
Author
|
Thanks for the clarification. Here's the correct change then oxc-project/oxc#9791 |
shulaoda
pushed a commit
to oxc-project/oxc
that referenced
this pull request
Mar 14, 2025
I think there's a typo in this rule's explanation. A correct clamp should have the upper bound in the min call, and the lower bound in the max call. I initially opened a PR directly on the .md file but it turns out to be generated from source oxc-project/website#317
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I think there's a typo in this rule's explanation. A correct clamp should have the upper bound in the
mincall, and the lower bound in themaxcall.This PR updates the .md file directly, but I just realized that there is a code comment very similar to this .md file directly in the rule's source
https://github.com/oxc-project/oxc/blob/b9ab60bde696d2742d3c5781084ee3c7bb99821e/crates/oxc_linter/src/rules/oxc/bad_min_max_func.rs#L22-L51
Is there some some automated build step that extracts those code comment into this .md file? (In which case my change would get overwritten and I should actually change the code comment instead).