Typing fixes + docs improvements #121
Conversation
minor grammer change
minor grammer change
minor grammer change
typing fixes + improved wording
added periods to stay consistant with other objects
minor grammer changes
made set_token docstring a bit more clear
| product_id: Product id of the asset | ||
| name: Name of the Asset | ||
| description: Description of the Asset | ||
| type: Type of the Asset |
There was a problem hiding this comment.
Maybe we shouldn't need to write "... of the Asset." over and over, although I don't know what exactly to put there instead
There was a problem hiding this comment.
Could make it "The asset's ..." but I'm not really sure if that's better.
There was a problem hiding this comment.
I have updated the attribute descriptions to have less repetition is it better now?
| @@ -44,16 +44,16 @@ class Badge(BaseBadge): | |||
| Represents a badge from the API. | |||
|
|
|||
| Attributes: | |||
| id: The badge Id. | |||
There was a problem hiding this comment.
is it "a badge ID" or "a badge's ID"? i honestly don't know what's best, but considering we talk about "user IDs" a lot I'm leaning towards "The badge ID."
There was a problem hiding this comment.
Something about "The badge ID" doesn't really sit well with me. "The badge's ID" just sounds more clear and it's more consistent with other pages too. What do you think?
minor grammer change
reworded some stuff to be more clear + replace Id with ID for consistency
replace Id with ID for consistency
reworded some stuff to be more clear + replace Id with ID for consistency
reworded some stuff to be more clear + fixed incorrect attribute descriptions + replaced word game with universe
reworded some stuff to be more clear + replace Id with ID for consistency
|
While adding the requested changes I found more things to fix as well so maybe review again when you have the chance please. |
Fixed warning admonition on get_instances
Reworded some attributes to be less repetitive
This pr aims to correct typos found in the docs, update existing docstrings to be more consistent with other pages and fix some typing issues.