RobiMez · GitHub

@RobiMez

Copy link Copy Markdown

Contributor

Checklist for PRs

  • Added .. versionadded:: version, .. versionchanged:: version or .. deprecated:: version to the docstrings for user facing changes (for methods/class descriptions, arguments and attributes)
  • Created new or adapted existing unit tests
  • Documented code changes according to the CSI standard
  • Added myself alphabetically to AUTHORS.rst (optional)
  • Added new classes & modules to the docs and all suitable __all__ s

Closed

harshil21

Copy link Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, left some comments below

harshil21

Copy link Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 more missed ones-

harshil21

Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
…to doc-fixes

harshil21

@harshil21

Copy link Copy Markdown

Member

pre-commit is failing since the line is too long (L129 & 154 in _poll.py). It should be < 100 chars

@RobiMez

Copy link Copy Markdown

Contributor Author

ill add some breaks

@RobiMez

@RobiMez

Copy link Copy Markdown

Contributor Author

done , also a few questions , was the line feed bit unnecessary ? is it because its a niche thing that people don't run into or it just didnt belong there ?

@RobiMez

Copy link Copy Markdown

Contributor Author

oh wait , trailing whitespace

@RobiMez

@harshil21

Copy link Copy Markdown

Member

@RobiMez it's the latter, the official documentation of Poll doesn't list that, so we don't write it.

@RobiMez

Copy link Copy Markdown

Contributor Author

@harshil21 Ohhh , makes sense , getting the hang of sphinx and your linting checks too. Ill tackle another class tomorrow as its getting late here. any priorities / which one needs most work ?

@harshil21

Copy link Copy Markdown

Member

@harshil21 any priorities / which one needs most work?

no priorities as of now, feel free to dive in the code and pick any class(es) you find which has a large discrepancy. Try to do multiple classes together so as to not produce many PRs for the same thing.

@harshil21

Merged

11 tasks

Read the original on github.com ↗