-
Notifications
You must be signed in to change notification settings - Fork 5.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Data] Document DataContext
#43578
[Data] Document DataContext
#43578
Conversation
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Can we call out which of these users are likely to want to configure and which ones are advanced? The best way would be by grouping them, and if that's not possible, put an Also some more detailed questions: What's the difference between For many of these, it is impossible for the users to know what they are doing, like The reference to |
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
@pcmoritz would you be opposed to us addressing this in a subsequent PR? I agree that the descriptions aren't very helpful right now. That said, before we invest time into improving the documentation, I was thinking we should go through the list of settings and remove unnecessary ones.
Fixed. |
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
Signed-off-by: Balaji Veeramani <[email protected]>
To globally configure data, you need to set attributes of the DataContext object. However, none of the DataContext settings are documented. This PR documents them, and also simplifies the DataContext module. --------- Signed-off-by: Balaji Veeramani <[email protected]>
To globally configure data, you need to set attributes of the DataContext object. However, none of the DataContext settings are documented. This PR documents them, and also simplifies the DataContext module. --------- Signed-off-by: Balaji Veeramani <[email protected]>
Why are these changes needed?
To globally configure data, you need to set attributes of the
DataContext
object. However, none of theDataContext
settings are documented. This PR documents them, and also simplifies theDataContext
module.Related issue number
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.