search

realworldocaml / mdx

Execute code blocks inside your documentation
ISC License
269 stars 45 forks source link

Undo the `;;` deprecation #398

Closed Leonidas-from-XIV closed 1 year ago

Leonidas-from-XIV commented 2 years ago

As described in https://github.com/tarides/platform-roadmap/issues/45 this undoes the ;; deprecation.

talex5 commented 1 year ago

https://github.com/tarides/platform-roadmap/issues/45 gives a 404 error for me. Would be good to document the reason for this change somewhere public.

Leonidas-from-XIV commented 1 year ago

I think it's ok to quote the roadmap item summary for a description of this change:

In a previous version of mdx, code blocks that do not end with a double semicolon (;;) have been deprecated. However, this has been criticized as creating a poor user experience, as it can make code less readable when semicolons are added to all code blocks. We want to remove this deprecation to improve the user experience of mdx.