👌 ub-test-reports: dedent a literal block after splitting it, so relative indentation survives every line boundary
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reading ub_test_reports.needs_export._literal_block and the tests covering literal block indentation. The issue describes the behavior change: split the text into lines before dedenting, while preserving byte-identical output for LF-only text. Add a test pinning a mixed-boundary block and confirm the existing LF-only behavior still passes.
Written by the indexing model from the issue text.
Description
ub_test_reports.needs_export._literal_block dedents a block's text with textwrap.dedent and then splits it with str.splitlines() (#2179), indenting every line so none ends the block early. textwrap.dedent works on line-feed lines only, so a sub-line produced by another line boundary (CR, NEL, LINE SEPARATOR, …) keeps its own leading whitespace: it stays INSIDE the block, but the block's relative indentation — which the docstring promises for tracebacks and diffs — holds across line feeds only (#2179's review, V3-F2; documented as such).
Enhancement: split first (splitlines()), then dedent the resulting lines, so the relative indentation survives every boundary. Byte-identical for text holding line feeds only; one pin for a mixed-boundary block.
- Dominant language
- Python
- Stars
- 309
- Forks
- 103
- Avg merge
- 4h 40m
- Merged PRs (30d)
- 154
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from useblocks/sphinx-needs
-
documentation pkg: sphinx-needs
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
useblocks/sphinx-needs#2379 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
useblocks/sphinx-needs#2338 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
useblocks/sphinx-needs#2335 ·
Maintainers usually reply within 1 day
-
bug pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
useblocks/sphinx-needs#2332 ·
Maintainers usually reply within 1 day
-
📚 the "own service" example in docs/services/index.rst cannot be registeredPossibly taken @chrisjsewell claimed this 10 days ago. Opendocumentation pkg: sphinx-needs
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
useblocks/sphinx-needs#2327 ·
Maintainers usually reply within 1 day
All issues in useblocks/sphinx-needs
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
Maintainers usually reply within 4 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
ClockGU/clockwork-backend#169 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
aws-samples/sample-per-model-bedrock#616 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
chnm/teachinghistory-hugo#47 ·
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
pandas-dev/pandas-stubs#2047 · 2 comments ·
Maintainers usually reply within 1 day