Opt in documentation #28
Open
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
…update an example
…gs (and soonto be misc) files
trevorflahardy
added
the
documentation
Luc1412
requested changes
Oct 13, 2024
Comment on lines
440
to
+443
| display_asset_path: Optional[:class:`str`] | ||
| The display asset path of this entry. | ||
|
|
||
| .. opt-in:: INCLUDE_PATHS |
There was a problem hiding this comment.
This field isn't affected by opt-in params.
Comment on lines
112
to
+119
| gameplay_tags: List[:class:`str`] | ||
| The gameplay tags for the playlist. | ||
|
|
||
| .. opt-in:: INCLUDE_GAMEPLAY_TAGS | ||
| path: :class:`str` | ||
| The path of the playlist. | ||
|
|
||
| .. opt-in:: INCLUDE_PATHS |
There was a problem hiding this comment.
Both fields are not affected by opt-in params.
docs/response_flags.rst
Outdated
There was a problem hiding this comment.
I think we should emphasize the user to only use the required opt-in parameters they actually need. And how the user benefits from it. (e.g. perfomance, bandwith)
Comment on lines
248
to
+251
| display_asset_path: Optional[:class:`str`] | ||
| The display asset path of the cosmetic, if available. | ||
|
|
||
| .. opt-in:: INCLUDE_PATHS |
There was a problem hiding this comment.
This attribute seems to not present anymore. I need to check back with Officer about it's status.
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.
Summary
This PR updates documentation to include information regarding the newly added
ResponseFlagsclass in the library.response_flagsparameter in the client.Response Flagssection in the documentation describing what response flags are and how to use them... opt-insphinx directive that marks an attribute as needing to be marked-in.Checklist