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

Update API docstrings #89

Open
13 tasks
skasberger opened this issue Feb 15, 2021 · 1 comment
Open
13 tasks

Update API docstrings #89

skasberger opened this issue Feb 15, 2021 · 1 comment
Assignees
@skasberger
Labels
pkg:api api related activities pkg:docs Documentation related activities prio:high status:confirmed Is a valid issue and will be moved forward soon. type:feature New feature

Comments

@skasberger
Copy link
Member

skasberger commented Feb 15, 2021 •
edited

Update docstrings from the api module.

Prepare

  • Read other docstring conventions and practices
  • Define docstring convention
  • Check: docstrings
    • code linting
    • testing

Implementation

  • Update docstrings
    • get_children: that parent node is not collected. or update function to collect the parent node to. pass parameter for this!
  • Update Docs: add docstrings convention to Contributor Guide
  • Run pytest
  • Run tox

Review

  • Docs

Follow-Ups

  • Update models docstrings
  • Update utils docstrings
@skasberger skasberger added type:feature New feature pkg:docs Documentation related activities pkg:api api related activities prio:high status:confirmed Is a valid issue and will be moved forward soon. labels Feb 15, 2021
@skasberger skasberger added this to the v0.4.0 milestone Feb 15, 2021
@skasberger skasberger self-assigned this Feb 15, 2021
@skasberger skasberger mentioned this issue Mar 14, 2021
Open
35 tasks
@pdurbin
Copy link
Member

pdurbin commented Feb 14, 2024

As discussed during the 2024-02-14 meeting of the pyDataverse working group, we are closing old milestones in favor of a new project board at https://github.com/orgs/gdcc/projects/1 and removing issues (like this one) from those old milestones. Please feel free to join the working group! You can find us at https://py.gdcc.io and https://dataverse.zulipchat.com/#narrow/stream/377090-python

@pdurbin pdurbin removed this from the v0.4.0 milestone Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@skasberger skasberger

Labels
pkg:api api related activities pkg:docs Documentation related activities prio:high status:confirmed Is a valid issue and will be moved forward soon. type:feature New feature
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pdurbin @skasberger