Fix and improve style of arcade.types.Color docstrings #2099
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
* Move summary line onto same line as opening triple quotes * Cross-ref color top-level def
* Move summary line to opening of docstring * Cross-ref Color * Rephrase summary line and brightness param explanation
* Fix broken cross-ref * Move summary line to top of the page * Rephrase for clarity
* Add cross-refs * Phrasing improvements
* Use code-block instead of :: * Cross-ref the summary line * Put examples first * Add cross-refs to external doc * Add error notification * Sort cross-refs
* Move unpack example to from_iterable * Move example code up to top * List creation helpers immediately in order of estimated usage likelihood * Add cross-references on HSV support via colorsys and colour * Inset unpack example with advice on when to use it
* Use code-block * Remove "Examples:" * Use clear values for the example * Use "Convert" instead of "Return" in the summary line * Explain what the decimal integer in the examples is
* Add cross-refs * Duplicate changes from from_uint32
* Show effects of repeat * Move summary line to first line of docstring
* s/swizzle_string/order/g * Add cross-ref to array and structr for people who want to pack data
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.
TL;DR: Style compliance improvements as reference for upcoming
Rectdoc workChanges:
.. code-block:: pythoninstead ofExamples::.. note::blocks with alternatives to features we didn't implement