react-markdown icon indicating copy to clipboard operation
react-markdown copied to clipboard

Deprecate the className prop

Open remcohaszing opened this issue 2 years ago • 7 comments

Initial checklist

  • [x] I read the support docs
  • [x] I read the contributing guide
  • [x] I agree to follow the code of conduct
  • [x] I searched issues and couldn’t find anything (or linked relevant results below)
  • [x] If applicable, I’ve added docs and tests

Description of changes

This deprecates the className prop, but does not remove it yet. Users should wrap the <Markdown> component inside a <div> manually instead.

Closes #781

remcohaszing avatar Nov 15 '23 20:11 remcohaszing

Hi! It seems some of the things asked in the template are missing? Please edit your post to fill out everything.

  • [ ] Initial checklist (todo)
  • [x] Description of changes

You won’t get any more notifications from me, but I’ll keep on updating this comment, and remove it when done!

If you need it, here’s the original template
<!--
  Please check the needed checkboxes ([ ] -> [x]). Leave the
  comments as they are, they won’t show on GitHub.
  We are excited about pull requests, but please try to limit the scope, provide
  a general description of the changes, and remember, it’s up to you to convince
  us to land it.
-->

### Initial checklist

*   [ ] I read the support docs <!-- https://github.com/remarkjs/.github/blob/main/support.md -->
*   [ ] I read the contributing guide <!-- https://github.com/remarkjs/.github/blob/main/contributing.md -->
*   [ ] I agree to follow the code of conduct <!-- https://github.com/remarkjs/.github/blob/main/code-of-conduct.md -->
*   [ ] I searched issues and couldn’t find anything (or linked relevant results below) <!-- https://github.com/search?q=user%3Aremarkjs&type=Issues -->
*   [ ] If applicable, I’ve added docs and tests

### Description of changes

TODO

<!--do not edit: pr-->

Thanks, — bb

github-actions[bot] avatar Nov 15 '23 20:11 github-actions[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (2245c64) 100.00% compared to head (40143b1) 100.00%. Report is 3 commits behind head on main.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #799   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines         1354      1337   -17     
  Branches       113       110    -3     
=========================================
- Hits          1354      1337   -17     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Nov 17 '23 09:11 codecov-commenter

I misinterpreted the meaning of the word deprecated here originally in a late evening.

I interpret deprecated as planned for change or removal with a warning. In this project deprecated means removed with an error, making deprecations semver major.

remcohaszing avatar Nov 17 '23 09:11 remcohaszing

Can you drop the changelog entry? I’ll write the changelog/migration manually when the time is there! Otherwise, :+1:

wooorm avatar Nov 17 '23 09:11 wooorm

Sure :+1:

It just feeld a bit weird to link a non-existent header from the code.

remcohaszing avatar Nov 17 '23 10:11 remcohaszing

Ah that’s why, hmm, then I’d do a <!-- To do: add heading for slug deprecate-classname --> Or these two comments might be enough!

wooorm avatar Nov 17 '23 10:11 wooorm

Since this change is breaking, this PR shouldn’t be merged until the next major anyway. I think this PR thread is plenty reminder once this gets merged. :)

remcohaszing avatar Nov 17 '23 10:11 remcohaszing