The current implementation needs to be further simplified

Open
#32 0 comments 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
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by locating the DocRender class and reading its current docstring manipulation, parsing, and rendering responsibilities. Determine appropriate boundaries for three separate components and check any existing tests or entry points that exercise DocRender. The work is done when each responsibility is factored out without changing documented behavior, with relevant tests still passing.

Written by the indexing model from the issue text.

Description

The DocRender class can be simplified:

  • Factor out the docstring manipulation operations into a separate class
  • Factor out parsing
  • Factor out rendering
Dominant language
Python
Stars
0
Forks
0
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 enthought/sectiondoc

All issues in enthought/sectiondoc

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.