Opt in documentation - Githubissues

Fortnite-API / py-wrapper

Python implementation for https://fortnite-api.com

https://fortnite-api.rtfd.org/en/latest

MIT License

40 stars 17 forks source link

Opt in documentation #28

Open trevorflahardy opened 2 days ago

trevorflahardy commented 2 days ago

Summary

This PR updates documentation to include information regarding the newly added ResponseFlags class in the library.

Updates the migration guide to include the response_flags parameter in the client.
Creates a Response Flags section in the documentation describing what response flags are and how to use them.
Creates a .. opt-in sphinx directive that marks an attribute as needing to be marked-in.
Updates all relevant attributes with said sphinx directive.

Checklist

[ ] If code changes were made then they have been tested.
- [ ] I have updated the documentation to reflect the changes.
[x] This PR fixes an issue.
[ ] This PR adds something new (e.g. new method or parameters).
[ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)
[x] This PR is not a code change (e.g. documentation, README, ...)