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

Docstrings #11

Open
bobturneruk opened this issue Aug 26, 2020 · 6 comments
Open

Docstrings #11

bobturneruk opened this issue Aug 26, 2020 · 6 comments
Assignees
@ns-rse @Ankur-AVP-Patel
Labels
documentation Improvements or additions to documentation
Projects
PGFinder Development

Comments

@bobturneruk
Copy link
Collaborator

Add docstrings to functions so we know what they're supposed to do.
@bobturneruk
Copy link
Collaborator Author

e.g. https://github.com/ScottishCovidResponse/simple_network_sim/blob/master/simple_network_sim/common.py

@Ankur-AVP-Patel
Copy link
Collaborator

Working on it now! Should be done by tomorrow (also commenting all my code so its easily to follow)

@bobturneruk bobturneruk mentioned this issue Feb 10, 2022
Merged
@bobturneruk
Copy link
Collaborator Author

Need to decide on a docstring format.

@Ankur-AVP-Patel
Copy link
Collaborator

What are the current suggestions?

@ns-rse ns-rse self-assigned this May 23, 2022
@ns-rse
Copy link
Collaborator

ns-rse commented Jun 9, 2022

I think this is mostly covered by #88 as I added Numpy doc-strings (I find them much easier to read in code than restructured text) to most things and that is now merged to master.

If @Ankur-AVP-Patel and @bobturneruk are able to bulk out the descriptions that I didn't know the meaning of that would then allow this issue to be closed.

@ns-rse
Copy link
Collaborator

ns-rse commented Jun 20, 2022

I'm trying to tidy a few loose ends up and get things released to PyPi today or tomorrow. If its possible to round out the docstrings that would be great as the documentation and website will update automagically.

@bobturneruk bobturneruk moved this from To do to Needs Triage in PGFinder Development Apr 17, 2023
@bobturneruk bobturneruk moved this from Needs Triage to Epics in PGFinder Development Apr 17, 2023
@TheLostLambda TheLostLambda added the documentation Improvements or additions to documentation label Aug 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ns-rse ns-rse

@Ankur-AVP-Patel Ankur-AVP-Patel

Labels
documentation Improvements or additions to documentation
Projects
PGFinder Development
Epics
Milestone
No milestone
Development

No branches or pull requests
4 participants
@TheLostLambda @ns-rse @bobturneruk @Ankur-AVP-Patel