Skip to content

section on presenting JSON, SQL and code in other prog. languages (#79)#102

Open
Man1ek27 wants to merge 7 commits into
habemus-python:mainfrom
Man1ek27:feature/issue-79
Open

section on presenting JSON, SQL and code in other prog. languages (#79)#102
Man1ek27 wants to merge 7 commits into
habemus-python:mainfrom
Man1ek27:feature/issue-79

Conversation

@Man1ek27

@Man1ek27 Man1ek27 commented Jun 5, 2026

Copy link
Copy Markdown

Closes #79

@slayoo

slayoo commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

🚀 reviewers: @mshupliakou & @filbet4

@mshupliakou

Copy link
Copy Markdown
image

screenshot of the reviewed section from the pdf generated on CI

@mshupliakou mshupliakou left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi! Thank you for the great Pull Request. The new section on 'Code listings' is very well-written, easy to understand, and fits perfectly into the handbook. Great job explaining why we should use code blocks instead of screenshots and keeping the explanations concise!

@mshupliakou

Copy link
Copy Markdown

Please don't forget to add your name to the colophon-authors

@mshupliakou

Copy link
Copy Markdown

Consider suggesting keywords like code listings, syntax highlighting, JSON validation, SQL linting to be added to the README file

@filbet4 filbet4 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition to the handbook. The section provides practical examples for several common formats (JSON, SQL, and other programming languages), making it easier for readers to apply the formatting conventions consistently. The examples are clear and easy to follow. Great section!

@Man1ek27

Copy link
Copy Markdown
Author

Please don't forget to add your name to the colophon-authors

Thanks for the reminder!

@Man1ek27

Copy link
Copy Markdown
Author

Nice addition to the handbook. The section provides practical examples for several common formats (JSON, SQL, and other programming languages), making it easier for readers to apply the formatting conventions consistently. The examples are clear and easy to follow. Great section!

Thanks for the review :)

@Man1ek27

Copy link
Copy Markdown
Author

Consider suggesting keywords like code listings, syntax highlighting, JSON validation, SQL linting to be added to the README file

Good advice, thanks a lot. I will consider it.

@Man1ek27 Man1ek27 force-pushed the feature/issue-79 branch 2 times, most recently from e265d9d to ed8bc46 Compare June 23, 2026 15:12
@Man1ek27 Man1ek27 force-pushed the feature/issue-79 branch 3 times, most recently from 9c212fc to 342f6a3 Compare June 23, 2026 15:32
@slayoo

slayoo commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Few more comments:

  • the hint "use line numbers only for ..." is not supplemented with info on how to enable line numbering
  • the hint "use the most specific language tag ..." is not supplemented with explanation of what is a language tag
  • it is unclear if the listing with output-dir: _book is just a random example or part of instruction on how to setup Quarto

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

section on presenting JSON, SQL and code in other prog. languages

4 participants