Too much custom Python?

Open
#12,519 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 3 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Active
Tech stack
haskell, python
Domain
documentation

Research direction

Start by reading doc/cabaldomain.py and the linked discussion in issue #12146, which contains the concerns about custom Python and CSS in the user guide documentation. Determine whether the custom code can be reduced or removed; the issue does not define a specific desired change or a completion test.

Written by the indexing model from the issue text.

Description

needs triage type: enhancement

Dunno, I'm rather sceptical about having more Python and more custom CSS, both of which has to be supported in eternity (e. g., if ReadTheDocs makes breaking changes).

Originally posted by @Bodigrim in https://github.com/haskell/cabal/issues/12146#issuecomment-5084321357

I like the change, but 80 new lines of Python, I don't fancy those.

Originally posted by @ffaf1 in https://github.com/haskell/cabal/issues/12146#issuecomment-5050380201

I tried to work with the custom Python we had for #12146 but maybe we already have too much custom Python for the user guide docs, in doc/cabaldomain.py?

Dominant language
Haskell
Stars
1.8k
Forks
766
Avg merge
5d 21h
Merged PRs (30d)
27

Getting set up

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 haskell/cabal

All issues in haskell/cabal

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.