docs: clarify SolaraViz keyword-only model arguments#3044
Merged
docs: clarify SolaraViz keyword-only model arguments#3044
Conversation
Collaborator
|
@Arjun-Sasi thanks for the PR and clarifying the issue, but this is not the optimal place to put this, can you add a markdown cell and add this as a warning in the tutorial file here. |
Contributor
Author
|
Hi @Sahil-Chhoker ,Thank you for the feedback.I have now, Added a Markdown warning cell and Updated tutorial examples (e.g., MoneyModel(...)) to use keyword arguments consistently, ensuring alignment with SolaraViz requirements. |
Collaborator
|
Thanks for making changes @Arjun-Sasi, looking at the ReadtheDocs build, this graph is missing: and the graph you build using updated model gives this graph: can you check what's wrong? |
Contributor
Author
|
Hi @Sahil-Chhoker ,Changes made in Mark Down and example to ensure that users include All parameters when converting from positional to keyword arguments. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What this PR does
Why this is needed
SolaraViz internally creates models using keyword arguments, which is currently undocumented and can confuse new users.