vinyldns / vinyldns/vinyldns-python

Add Parameter Type Information to Docstrings

Open
#76 0 comments 0 reactions 1 assignee View on GitHub

@nspadaccino is already working on this.

Since Dec 8, 2022.

area/documentation
Dominant language
Python
Stars
12
Forks
24
Avg merge
9d 13h
Merged PRs (30d)
2

Description

Description

Docstrings are missing type info for parameters, which has led to confusion amongst some users. We should also enhance the docstrings with more detailed information where necessary.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.