Replace code directive by the sphinx code-block#1714
Conversation
unman
left a comment
There was a problem hiding this comment.
I am somewhat opposed to global changes like this. The results are difficult to review.
In this case I'd like to FIRST discuss the potential benefits to users and THEN move to implement if agreed.
What are the concrete advantages to users of this global change?
|
I was lazy, tried to batch replace everything to see if it worked and getting no warning, I made this PR. Now, I'm reconsidering it and the few advantages I can find are limited. I still think it would be good to favor We can also remove the mention to What do you think? |
|
I thought that the code options were being brought in line with the
codeblock options. Sure there is a PR for this.
|
|
There are currently two different PRs on the Sphinx side: one keeping things as they are but changing the docs, the other one making I don't think we can expect them to be shipped in a new Sphinx version very soon, so I would like to just fix the 2 examples where the |
The
code::directive is a directive compatible with docutils, allowing less options than thecode-block::orsourcecode::Sphinx directives.See this comment: sphinx-doc/sphinx#14411 (comment)
This PR replaces
code::bycode-block::everywhere. Another option is to change only the documentation style guide and the how-to, I'm fine with both.