For 5.0.0: Rename HighlightLines::highlight() to highlight_line()#406
Conversation
To make it clear that the function takes one line at a time. This require a semver major bump, but we need to do that anyway due to the syntax lazy-loading changes. Fixes trishume#314
89733f0 to
273e0f4
Compare
|
Looks good. Thanks! |
|
Big thanks for taking a look. (I will move out the CHANGELOG.md changes into a separate PR to avoid conflicts with other upcoming PRs.) |
273e0f4 to
43147ef
Compare
|
Can you change this to a deprecation of the old name? I know it's a major version bump so we can just remove it, but this is the biggest API change and deprecations are way friendlier then renames given that the compile error can directly tell the user how to rename their call. It'll make upgrading to the new major version much smoother. Maybe the warning can even be like "highlight was renamed to highlight_line to make it clear it should be passed a single line at a time" |
|
Sure, no problem at all. I have pushed a commit to fix that. Here is how the deprecation message looks in the wild. (Generated by temporarily using the deprecated variant in our own example code.) |
To make it clear that the function takes one line at a time.
This require a semver major bump, but we need to do that anyway due to the
syntax lazy-loading changes.
Fixes #314