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

Clean up ingestion model docs -- specifically document attributes better #184

Open
evamaxfield opened this issue Apr 29, 2022 · 1 comment
Open

Clean up ingestion model docs -- specifically document attributes better #184

evamaxfield opened this issue Apr 29, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@evamaxfield
Copy link
Member

https://councildataproject.org/cdp-backend/cdp_backend.pipeline.html#cdp_backend.pipeline.ingestion_models.IngestionModel

  • each property should be documented
  • try to hide the from_json and from_dict methods
  • add example for every one
  • mark each model as required or optional
@evamaxfield evamaxfield added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 29, 2022
@evamaxfield
Copy link
Member Author

Major doc overhaul, use:

"sphinx.ext.autosummary",
"sphinx_autosummary_accessors",

Database Models
---------------

.. currentmodule:: cdp_backend.database.models
.. autosummary::
    :toctree: generated/

    File
    Person

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@evamaxfield