docs: fix Syntax section in numeric function documentation #3444 #3448
Closed
apoorv-x12 wants to merge 3 commits into
Closed
docs: fix Syntax section in numeric function documentation #3444 #3448apoorv-x12 wants to merge 3 commits into
apoorv-x12 wants to merge 3 commits into
Conversation
This PR updates the Syntax: section in the JSDoc for the math.numeric function to correctly reflect valid usage patterns. It addresses issue #3444.
Owner
|
Thanks @apoorv-x12 ! Can you restore the original indentation? You removed two spaces at the start of every line. |
Author
|
Restored the indentation of the commented section to its original format. |
Owner
|
The diff https://github.com/josdejong/mathjs/pull/3448/files still looks quite confusing, I think you added two spaces indentation inside the comment? Can you have a look at that? I would expect only the lines with the syntax and return type description being changed. |
Owner
|
@apoorv-x12 can you have another look at the indentation? |
josdejong
added a commit
that referenced
this pull request
May 28, 2025
Owner
|
I've addressed this issue now via ee7dc26, closing this PR now. |
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.
Fix: Improve doc syntax for
numeric()function #3444This PR fixes minor documentation inconsistencies in the
numeric()function docstring, including:Tested with
npm run testandnpm run lint— all tests passing ✅This is a small doc fix, so might fall under type: docs.
Thanks for maintaining this awesome library 🙌