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

Add module docstrings #272

Open
RobertCraigie opened this issue Feb 4, 2022 · 2 comments · May be fixed by #731
Open

Add module docstrings #272

RobertCraigie opened this issue Feb 4, 2022 · 2 comments · May be fixed by #731
Labels
good first issue Always wanted to get involved in an open source project but don’t know where to begin? Welcome! kind/docs A documentation change is required. level/beginner Estimated as solvable by a new contributor priority/low topic: docs Improvements or additions to documentation
Projects
v1.0.0

Comments

@RobertCraigie
Copy link
Owner

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!
@RobertCraigie RobertCraigie added topic: docs Improvements or additions to documentation good first issue Always wanted to get involved in an open source project but don’t know where to begin? Welcome! kind/docs A documentation change is required. level/beginner Estimated as solvable by a new contributor priority/low labels Feb 4, 2022
@RobertCraigie RobertCraigie added this to To do in v1.0.0 via automation Feb 4, 2022
@Snipy7374
Copy link

Hi, i would like to work on this

@RobertCraigie
Copy link
Owner Author

Amazing! Let me know if you have any questions!

@Snipy7374 Snipy7374 linked a pull request Mar 19, 2023 that will close this issue
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Always wanted to get involved in an open source project but don’t know where to begin? Welcome! kind/docs A documentation change is required. level/beginner Estimated as solvable by a new contributor priority/low topic: docs Improvements or additions to documentation
Projects
Prisma Client Python
Status: Backlog
v1.0.0
To do
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: define module level docstrings Snipy7374/prisma-client-py
2 participants
@RobertCraigie @Snipy7374