Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Document application object model #150

Open
jayaddison opened this issue Jun 24, 2020 · 1 comment
Open

Document application object model #150

jayaddison opened this issue Jun 24, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@jayaddison
Copy link
Member

Is your feature request related to a problem? Please describe.
For some issues such as #148 it will be beneficial to have a clearly-defined and cleanly-implemented object model within the application.

Currently the objects available (recipes, products, meals) are defined only in the code, and there is no accompanying documentation attempting to define the terminology, relationship and purpose between the models.

Describe the solution you'd like
A simple document should be added that explains the list of application objects, their purposes, and referential links between them.
@jayaddison jayaddison added the enhancement New feature or request label Jun 24, 2020
@jayaddison
Copy link
Member Author

This documentation could be placed inline next to the application's local database schema.

@jayaddison jayaddison mentioned this issue Oct 23, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jayaddison