Skip to content
This repository was archived by the owner on Apr 15, 2025. It is now read-only.

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 subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add module docstrings

1 participant