Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Reformat all docstrings to conform to the Google format #187

Open
AlexIoannides opened this issue Jul 5, 2022 · 3 comments
Open

Reformat all docstrings to conform to the Google format #187

AlexIoannides opened this issue Jul 5, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation tech-debt

Comments

@AlexIoannides
Copy link
Contributor

"As a Bodywork Developer, I would like all docstrings to be in the Google format, so that they are easier to read."

Tasks

  • Investigate pyment and docconvert as possible tools for automating this tedious task.
  • Convert doctoring formats!
@AlexIoannides AlexIoannides added documentation Improvements or additions to documentation good first issue Good for newcomers tech-debt labels Jul 5, 2022
@gadc1996
Copy link

gadc1996 commented Jul 5, 2022

Can i do it?

@AlexIoannides
Copy link
Contributor Author

Certainly!

Thank you 🙏🏽

@gadc1996
Copy link

gadc1996 commented Jul 5, 2022 •
edited

Here is the PR
Let me know if there is something i need to change

@AlexIoannides AlexIoannides removed the good first issue Good for newcomers label Jul 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation tech-debt
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@AlexIoannides @gadc1996