Documentation fixes

Open
#95 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by inventorying the Python source files, comments, and existing docstrings covered by this issue. Review the project's current Sphinx documentation conventions before deciding how to describe arguments and outputs. Done means comments are converted where appropriate, documented functions cover their interfaces, and previously undocumented methods have clear docstrings.

Written by the indexing model from the issue text.

Description

maintenance

A lot of documentation are comments, not documentation strings – they should be changed.

Most documentation strings don't actually document what the different arguments are and what the expected outputs are – using the sphinx format to document that would be nice.

Finally, many methods and functions are not documented at all, that should also be fixed.

Dominant language
Python
Stars
973
Forks
343
No merged PRs in 30d

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.

More from tlsfuzzer/python-ecdsa

All issues in tlsfuzzer/python-ecdsa

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.