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.

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

docs: Apply consistent md code block indentation #8536

Closed

Conversation

doolio
Copy link
Contributor

@doolio doolio commented Nov 7, 2023

Note, I did not adjust the auto-generated text code blocks in configuration.md as I presumed any changes would be overwritten. To apply the same style for those blocks I presume it would have to be applied from where those blocks are generated. But I was unsure where that was.

@zanieb
Copy link
Member

zanieb commented Nov 7, 2023

Is this enforceable by one of our pre-commit tools for linting markdown? I'm not sure I really care either way but if it's not checked by a tool it's probably not going to remain consistent.

@doolio
Copy link
Contributor Author

doolio commented Nov 7, 2023

This PR relates to the inconsistency I highlighted here and it was explained later that it is required or did I misinterpret that explanation. @charliermarsh also added indentation to code blocks (commit 231aff0) in another PR I submitted so I presumed that was the preferred style.

But in reality my understanding is indentation is not necessary if the code block is fenced which they all seemed to be. So if anything the indentation should be removed from all code blocks, no?

Edit:

Is this enforceable by one of our pre-commit tools for linting markdown?

I don't know but if so then it doesn't seem to enforce it consistently whichever style is preferred.

@trag1c
Copy link
Contributor

trag1c commented Nov 7, 2023

did I misinterpret that explanation

yep, I specifically said that

[...] indented code blocks are only used for tabs because that's the syntax they require [...]

Charlie's commit specifically corrects that

I think this PR can be closed 👍

@doolio
Copy link
Contributor Author

doolio commented Nov 7, 2023

Ah I see. Thanks for the clarification.

@doolio doolio closed this Nov 7, 2023
@doolio doolio deleted the consistent-md-code-blk-indentation branch November 7, 2023 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants