Update documentation for @sym/heaviside.m #1102
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
- rewrote examples 2-5 in the documentation, noting new default value at sym(0), as well as how to override the definition at 0 for both right and left continuous values. - also noted that the function can be used on a matrix and is called for each element. - Fixes gnu-octave#1091
cbm755
reviewed
Apr 9, 2022
inst/@sym/heaviside.m
Outdated
| @@ -32,34 +33,41 @@ | |||
| %% @end group | |||
| %% @end example | |||
| %% | |||
| %% By default, the value at zero is undefined: | |||
| %% There are various conventions for 'heaviside(sym(0))'; this function | |||
| %% returns (sym) 1/2 by default. | |||
There was a problem hiding this comment.
I think you should just say "returns 1/2 by default" or maybe "returns the midpoint by default:" (and let the example show it is 1/2).
Other than that, this looks ready to go1
- was '(sym) 1/2' and is now 'the midpoint'
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.
sym(0), as well as how to override the definition at 0 for both right
and left continuous values.
each element.