Models and Schemas, Batch 1: Simple/One-Off Models #127
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.
Description
This is the first batch of models and schemas for #72, covering the simpler, one-off models that don't have relationships. Further PRs will be batched out according to groups of related models.
Changes
Add simple example model for
Comment
.Correct schema names for
OtherModel
.Skipping defining the model/schemas this time, as nothing else uses them and it's irrelevant to just showing an additional endpoint router. I considered changing it to another more commonly used model/schema set, but decided it wasn't worth the hassle of figuring out.
Add
pymdownx.details
tomkdocs
config.Used for collapsed/folded code blocks as needed for doing multiple file includes via snippets.
Model, schemas, and doc fixes for
Item
.This makes use of the
pymdownx.details
extension to allow for collapsed/folded code example blocks. (Other commits/PRs to come will also use this, but this is the first set.) I also replaced some uses ofMyModel
andYourModel
(and associated schemas) withItem
(and etc.) for simplicity, although there will also be someMyModel
usage in the following commit.MyModel
model, schemas, docs/docstrings.Tests
No changes to tests; this is purely in documentation and examples.
Checklist