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.

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

docs: define module level docstrings #731

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Snipy7374
Copy link

@Snipy7374 Snipy7374 commented Mar 19, 2023

Change Summary

Hi, my wording isn't that great so if someone wants to suggests changes it would be much appreciated.
Furthermore i haven't defined docstrings for

  • builder.py.jinja
  • fields.py.jinja
  • partials.py.jinja

because i'm unsure how to describe them. Additionally i was wondering if we could use examples (in docstrings) where possible and (maybe) generate them dinamycally (using jinja funtionalities) based on models etc...

Checklist

  • Unit tests for the changes exist
  • Tests pass without significant drop in coverage
  • Documentation reflects changes where applicable
  • Test snapshots have been updated if applicable

Agreement

By submitting this pull request, I confirm that you can use, modify, copy and redistribute this contribution, under the terms of your choice.

@Snipy7374 Snipy7374 changed the title define module level docstrings docs: define module level docstrings Mar 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add module docstrings
1 participant