Add back summary table for pack/unpack directives #12349
Conversation
* This concise summary is very helpful e.g. to find the right Integer directive, and is much better at getting an overview than very long text. * From ruby#6567 * I merged the tables for Array#pack and String#unpack, there were almost the same except for String and Misc. directives.
|
This doesn't render correctly: 
|
|
May I take charge of making this work? Earlier, I removed this tabular material in favor of case-wise treatment with examples; should have added the latter w/o removing the former. Irony: Lately I've proposed (and have been adding) certain "In Brief" sections. What I did here is very counter to that. Duh. |
|
@BurdetteLamar when you get a chance, can you also add a few table examples to https://github.com/ruby/rdoc/blob/master/ExampleRDoc.rdoc? That'll be super helpful too 🙏 |
|
Okay, silence gives consent; I'm taking over this PR. When this page was new, @peterzhu2118 was my reviewer; @eregon and @zenspider, can I count on you to review here? Marking as draft while I work on this. |
Tunes up the tabular data and moves it to the top.
|
@eregon, could not add you as a reviewer, but please review anyway. |
@st0012, the page you site is hideously underpopulated (and, I think, probably should be removed). Something might be said about ascii tables in https://github.com/ruby/rdoc/blob/master/doc/rdoc/markup_reference.rb, perhaps under "Verbatim Text"? May also be helpful to have a section "Tables" that mentions GFM tables and ascii tables? |
Co-authored-by: Stan Lo <stan001212@gmail.com>
This comment has been minimized.
This comment has been minimized.
✅ All Tests passed!✖️no tests failed ✔️65126 tests passed(2 flakes) |
✅ All Tests passed!✖️no tests failed ✔️65145 tests passed(2 flakes) |
✅ All Tests passed!✖️no tests failed ✔️65231 tests passed(3 flakes) |
4 participants
@st0012 Is there special syntax for tables in RDoc?
I used the same markup as before (without leading
#), so I suppose it should just work?Note: I don't have much time to work on this, so if some small edits are wanted please just push them to this PR or merge & commit them after.
cc @st0012 @BurdetteLamar @zenspider