-
Notifications
You must be signed in to change notification settings - Fork 1
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
Update schema.md - reference introduction #146
Conversation
update introduction section to better reflect key elements of each component. Unsure whether class diagram should remain or be replaced with something derived directly from updated schema
Proposed shower descriptions for each component section, and edited the top summary. Text removed can be put into examples where they would be accompanied by code snippets.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixes a few typos and added some suggestions to improve the consistency of the description and ensure that in every case users understand that the standard is only detailing metadata.
Co-authored-by: odscjen <[email protected]>
Co-authored-by: odscjen <[email protected]>
Co-authored-by: odscjen <[email protected]>
Co-authored-by: odscjen <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Jen, can you check your comments have all been committed (some are outdated and I wanted to commit but couldn't)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of minor copy editing changes left.
Also don't forget to update the change log and run ./manage.py prior to the final commit
Co-authored-by: odscjen <[email protected]>
Co-authored-by: odscjen <[email protected]>
Add entry to Normative section
Please run pre-commit, I have updated changelog. |
Update introduction section to better reflect key elements of each component. Unsure whether class diagram should remain or be replaced with something derived directly from updated schema
Related issues
addresses #148
Merge checklist
./manage.py
pre-commit