Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Parse doc comments with correct newline persistance #1762

Open
wawel37 opened this issue Nov 25, 2024 · 1 comment
Open

Parse doc comments with correct newline persistance #1762

wawel37 opened this issue Nov 25, 2024 · 1 comment
Assignees
@FroyaTheHen
Labels
scarb-doc
Milestone
Scarb Doc

Comments

@wawel37
Copy link
Member

wawel37 commented Nov 25, 2024 •
edited
Loading

As for now, scarb doc ignores all newline (beside code blocks). It is a problem because some of the markdown elements require to be parsed with newlines being persisted (for example a list).

AC:

  • Make scarb doc parsing comments persist newlines within a markdown elements, that it should (codeblocks, lists and any other).
@wawel37 wawel37 added this to Scarb Nov 25, 2024
@wawel37 wawel37 converted this from a draft issue Nov 25, 2024
@wawel37 wawel37 self-assigned this Nov 25, 2024
@maciektr maciektr added this to the Scarb Doc milestone Jan 17, 2025
@maciektr maciektr assigned maciektr and FroyaTheHen and unassigned maciektr Jan 17, 2025
@maciektr maciektr moved this from Backlog to Todo in Scarb Jan 17, 2025
@maciektr
Copy link
Contributor

Related issue: #1795

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@FroyaTheHen FroyaTheHen

Labels
scarb-doc
Projects
Scarb
Status: Todo
Milestone
Scarb Doc
Development

No branches or pull requests
3 participants
@wawel37 @maciektr @FroyaTheHen