Deprecate the RedCloth API compatibility layer #401
Conversation
Since the RedCloth API layer is now deprecated and will be removed in 4.0, let's move this class to its own file to make the main one more clear. We would have to require "redcarpet/compat" to be fully backward compatible but the RedcarpetCompat class shouldn't be use anyway. It is just a convenient way not to override the `Markdown` one if it already exist.
Deprecate the RedCloth API compatibility layer
|
This is a breaking change that affects all users of YARD, since YARD relies on the Compat class in 3.x. If you make a change in a minor version update you should ensure backward compatibility for the rest of the major version stream, even if the thing was deprecated. I think the |
Isn’t that was $stderr is for? |
Fixes a backward incompatible change introduced in v3.2.0 via #401.
Well, unless I'm wrong this isn't a problem in the general case but it is for people that are relying on the Anyway, v3.2.1 has been released so you don't have to change code on your side if you want to upgrade Redcarpet. |
As of #401, the compatibility layer lives in its own file but since Yard provides a Redcarpet support and relies on the same symbol to specify the provider and the require string (https://git.io/vDLyr), we can't ask them to "require 'redcarpet/compat'" so let's still require the compatibility layer by default. Fixes #589.
Hello,
This is just a pull request that deprecates the RedCloth API compatibility layer. We can move the
RedcarpetCompatclass to its own file and remove its documentation from the README file. The only drawback is that people relying on theRedcarpetCompatclass should now putrequire 'redcarpet/compat'in their code but this is no-sense to use it overMarkdown.We can't throw deprecation warnings as this would mess the users' output so let's simply remove any reference to it for now. We will be able to remove it once we reach Redcarpet 4.0.
Have a nice day!