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.

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

Docstrings, docstrings, and more docstrings #7

Closed
langevin-usgs opened this issue Jan 27, 2015 · 5 comments
Closed

Docstrings, docstrings, and more docstrings #7

langevin-usgs opened this issue Jan 27, 2015 · 5 comments

Comments

@langevin-usgs
Copy link
Contributor

Just wanted to check in with everyone about docstrings. I am going to be updating the flopy3 sphinx documentation over the next couple of days (in preparation for our class in 2 weeks). If you get the chance to update the docstrings for your assigned files, that would be great. The wiki with the file assignments is at:

https://github.com/modflowpy/flopy/wiki/Docstring-Assignments

thanks!

@jjstarn-usgs
Copy link
Contributor

It's still on my to-do list; just a little behind schedule.

On Tue, Jan 27, 2015 at 10:10 AM, langevin-usgs notifications@github.com
wrote:

Just wanted to check in with everyone about docstrings. I am going to be
updating the flopy3 sphinx documentation over the next couple of days (in
preparation for our class in 2 weeks). If you get the chance to update the
docstrings for your assigned files, that would be great. The wiki with the
file assignments is at:

https://github.com/modflowpy/flopy/wiki/Docstring-Assignments

thanks!


Reply to this email directly or view it on GitHub
#7.

Jeff Starn Ph.D.
Research Hydrologist
USGS National Water-Quality Assessment
101 Pitkin Street, East Hartford, CT 06108

jjstarn@usgs.gov
office: (860) 291-6746
cell: (860) 335-8381

@mbakker7
Copy link
Contributor

Absolutely.
Need to get that done,
Mark

On Tue, Jan 27, 2015 at 4:10 PM, langevin-usgs notifications@github.com
wrote:

Just wanted to check in with everyone about docstrings. I am going to be
updating the flopy3 sphinx documentation over the next couple of days (in
preparation for our class in 2 weeks). If you get the chance to update the
docstrings for your assigned files, that would be great. The wiki with the
file assignments is at:

https://github.com/modflowpy/flopy/wiki/Docstring-Assignments

thanks!


Reply to this email directly or view it on GitHub
#7.

@mbakker7
Copy link
Contributor

All,

I think the doc string of the mfghb.py file may serve as a template for
other
layer-row-column-data type packages. If you have suggestions to improve the
'template' let me know. We should try to keep the docs of these
layer-row-column-data type packages similar, I think,

Mark

@ghost
Copy link

ghost commented Jan 27, 2015

I believe mine are up to date. Let me know if I’m wrong.

Mike

On Jan 27, 2015, at 3:01 PM, mbakker7 notifications@github.com wrote:

All,

I think the doc string of the mfghb.py file may serve as a template for
other
layer-row-column-data type packages. If you have suggestions to improve the
'template' let me know. We should try to keep the docs of these
layer-row-column-data type packages similar, I think,

Mark

Reply to this email directly or view it on GitHub #7 (comment).

@jjstarn-usgs
Copy link
Contributor

thanks for that suggestion. I was planning on using one of the other
packages as a template, now I know which one to use...

On Tue, Jan 27, 2015 at 4:01 PM, mbakker7 notifications@github.com wrote:

All,

I think the doc string of the mfghb.py file may serve as a template for
other
layer-row-column-data type packages. If you have suggestions to improve the
'template' let me know. We should try to keep the docs of these
layer-row-column-data type packages similar, I think,

Mark


Reply to this email directly or view it on GitHub
#7 (comment).

Jeff Starn Ph.D.
Research Hydrologist
USGS National Water-Quality Assessment
101 Pitkin Street, East Hartford, CT 06108

jjstarn@usgs.gov
office: (860) 291-6746
cell: (860) 335-8381

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants