docs: document distribution parameters and fix stale scalar rotation example#1497
Open
laurapiro17 wants to merge 1 commit into
Open
docs: document distribution parameters and fix stale scalar rotation example#1497laurapiro17 wants to merge 1 commit into
laurapiro17 wants to merge 1 commit into
Conversation
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
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.
Description
small docs-only change to the random-parameter docs:
tio.Affine(degrees=15)with the comment "rotate uniformly between -15° and 15°", but in v2 a scalar is deterministic (it always rotates 15°). changed the example todegrees=(-15, 15)so it matches the comment.Distributionis listed as a valid parameter spec in the reference and mentioned in the tutorial and migration guide, but it was never shown anywhere. added a## Distributionsection toreference/random_parameters.md(parallel to## Choice) plus a short example in the tutorial, covering both broadcasting and per-axis mixing.checked that every snippet runs against the current code.
Checklist
CONTRIBUTINGdocs and have a developer setup ready