twisted / twisted/klein

A lot of built-in types are annotated in epytext as code and perhaps should be links

Open
#390 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
838
Forks
123
Avg merge
7h 58m
Merged PRs (30d)
12

Description

A lot of built-in types are annotated in epytext as code (C{type}) and perhaps should be links (L{type}).

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

Search the repository's epytext documentation for built-in types annotated with C{type}. Determine which annotations should link to the corresponding types, then update the selected documentation references from code formatting to links and verify the affected documentation still builds correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.