Enable DDoc Markdown by default#11654
Conversation
|
Thanks for your pull request, @wilzbach! Bugzilla referencesYour PR doesn't reference any Bugzilla issue. If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog. Testing this PR locallyIf you don't have a local development environment setup, you can use Digger to test this PR: dub run digger -- build "master + dmd#11654" |
d46f1d0 to
8810593
Compare
| Feature("dip25", "useDIP25", | ||
| "implement https://github.com/dlang/DIPs/blob/master/DIPs/archive/DIP25.md (Sealed references)", false, true), | ||
| // trigger deprecation message once D repositories don't use this flag anymore | ||
| Feature("markdown", "markdown", "enable Markdown replacements in Ddoc", false, false), |
There was a problem hiding this comment.
Druntime and Phobos are compiled with -de, so this must be done as a multi-stage PR iteration.
8810593 to
d8ec05e
Compare
9227234 to
44d9d27
Compare
|
Nice! I was wondering today when should the other |
44d9d27 to
b269642
Compare
Most |
| * { | ||
| * invs[0](), invs[1](), ...; | ||
| * } | ||
| * --- |
There was a problem hiding this comment.
Otherwise it generates:
<p class="para">
Create inclusive invariant for struct/class by aggregating
all the invariants in invs[].
void __invariant() const [pure nothrow @trusted]
{
invs<a href="">0</a>, invs<a href="">1</a>, ...;
}
</p>
|
(Windows failure is unrelated - see #11653) |
changelog/markdown-default.dd
Outdated
| @@ -0,0 +1,3 @@ | |||
| DDoc Markdown support has been enabled by default | |||
|
|
|||
| If you encounter issues with this transition, use `-revert=markdown` and report an issue. | |||
There was a problem hiding this comment.
Actually, I don't think this description is enough, because:
- Let's not kid ourselves, most users don't use
-preview. So re-stating some informations on it (where the documentation can be found, and an overview of the features / changes) is IMO important. - It's also important to have more than a one-liner for such an important feature. I know many users have asked for it over the year, and we should be a bit more proactive in marketing the good changes we're doing.
- It's not a usual practice, so this is only a suggestion, but I would add a thank you note to @dgileadi for championing this.
There was a problem hiding this comment.
Fair enough. I'm really lazy with changelog entries. I updated this one.
It's not a usual practice, so this is only a suggestion, but I would add a thank you note to @dgileadi for championing this.
Great idea! We should make this the usual practice ;-)
8cd65f4 to
1d0ff75
Compare
Heh |
1d0ff75 to
6121df2
Compare
Yeah, this is enforced now and should hopefully avoid silent C++ header breakage. |
Markdown support has been in preview for more than a year and is used for the official docs (see e.g. #9645).
It's time to enable it by default. If folks encounter issues, there will be
-revert=markdownfor a while.FYI @dgileadi