IronLanguages / IronLanguages/ironpython3

Missing doctests on builtin methods

Open
#1,630 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
2.8k
Forks
316
Avg merge
1d 9h
Merged PRs (30d)
1

Description

The following builtin methods have doctests included in their __doc__ string:

  • bin
  • float.as_integer_ratio
  • float.fromhex
  • float.hex
  • hex
  • int
  • int.bit_length
  • oct

Contributor guide

Open the contributing guide

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.

Research direction

Start by locating the builtin method implementations for bin, float.as_integer_ratio, float.fromhex, float.hex, hex, int, int.bit_length, and oct, then compare their doc strings with the stated doctest coverage. Add the missing doctests consistently and verify that the doctests are present for all listed methods.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.