This repository was archived by the owner on Apr 15, 2025. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 93
This repository was archived by the owner on Apr 15, 2025. It is now read-only.
Add module docstrings #272
Copy link
Copy link
Open
Labels
good first issueAlways wanted to get involved in an open source project but don’t know where to begin? Welcome!Always wanted to get involved in an open source project but don’t know where to begin? Welcome!kind/docsA documentation change is required.A documentation change is required.level/beginnerEstimated as solvable by a new contributorEstimated as solvable by a new contributorpriority/lowtopic: docsImprovements or additions to documentationImprovements or additions to documentation
Description
Problem
We could improve the readability / experience reading through the library source code if there were module level docstrings.
Suggested solution
All python modules should include a docstring explaining what the purpose of the module is:
"""
prisma.client
~~~~~~~~~~~~~
Main interface for the Client API - handles connecting, disconnecting
and querying the underlying Prisma Engine.
:auto-generated:
"""For contributors
This is a fairly simple change but it may not be exactly clear what each module does - if you need any help feel free to ask a question on the discord.
If you update auto-generated modules make sure you update the snapshots!
Metadata
Metadata
Assignees
Labels
good first issueAlways wanted to get involved in an open source project but don’t know where to begin? Welcome!Always wanted to get involved in an open source project but don’t know where to begin? Welcome!kind/docsA documentation change is required.A documentation change is required.level/beginnerEstimated as solvable by a new contributorEstimated as solvable by a new contributorpriority/lowtopic: docsImprovements or additions to documentationImprovements or additions to documentation
Projects
Status
Backlog