docs: overhauled member-ordering docs and types #4873
Conversation
|
Thanks for the PR, @JoshuaKGoldberg! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Codecov Report
@@ Coverage Diff @@
## main #4873 +/- ##
==========================================
+ Coverage 91.77% 94.25% +2.48%
==========================================
Files 227 153 -74
Lines 10611 8301 -2310
Branches 3283 2701 -582
==========================================
- Hits 9738 7824 -1914
+ Misses 591 263 -328
+ Partials 282 214 -68
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
|
||
| ### Member types (granular form) | ||
| <details> | ||
| <summary>Expand this to see the full list of all supported member type groups.</summary> |
There was a problem hiding this comment.
This exposes a bug(?) in Docusaurus. The right-side headings menu still displays headings within a <details> (which should be allowed) even if collapsed. Clicking those heading links does nothing while collapsed.
member-ordering._.TypeScript.ESLint.-.Google.Chrome.2022-04-29.09-11-02.mp4
There was a problem hiding this comment.
There was a problem hiding this comment.
If the bug isn't accepted -or if you the reviewer hate this pattern- I can remove the <details> and move its content to a new section after ## Examples. Otherwise I'd consider that bug blocking merging this PR.
The rest of the PR should still be ready for review though! ✨
There was a problem hiding this comment.
Ha, nice: facebook/docusaurus#7265 (comment)
PR Checklist
Overview
A few touchups:
memberTypesandorderin the rule docs.<!-- tabs -->formatMemberTypemore clearThrowing up a draft because I did this in my stream and didn't have time to finish. 😄 Will finish soon I hope!✅ https://www.twitch.tv/videos/1467641307