Improve DynamicTable documentation #639
Merged
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.
Motivation
Added a new tutorial on
DynamicTable
and renamed the old one to be a "how-to guide", inspired by the Divio documentation system: https://documentation.divio.com/A tutorial should be learning-oriented. The point is to get the user started learning by doing, not serve as a manual or reference. It should focus on concrete steps, not abstract concepts. And it should provide the minimum necessary explanation. Other details can be provided in a how-to guide or reference.
Also added documentation on the options for
DynamicTable.get
andDynamicTable.to_dataframe
.ref: #579 (comment)
Checklist
flake8
from the source directory.