Update documentation on scale modes. #2455
Merged
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 was looking into what the available options for scale modes were, and found that the documentation was noticeably blank. This left me guessing as to the intended behavior of each mode.
I eventually ended up creating a simple test bench project that would allow me to change the scale mode easily, created a succinct description of the behavior each policy displayed, and added them to the HaxeDocs for the relevant source files (which I presume is where the API reference page pulls from, please correct me if I am wrong on this).