feat(regexp-assemble): Update data file comment #2565
Conversation
The header comment in the regexp-assemble data files was no longer in sync with the implementation after the merge of the improvements to the preprocessing engine of regexp-assemble.
0a12c52 to
2f3e257
Compare
2f3e257 to
234ab19
Compare
|
We have been discussing about dropping the header from the regexp-assemble data files. The header explains some basics but obviously leaves out a lot. The issue is that the header changes from time to time and every time it does we need to update 20+ files. For anyone interested in the matter, please with 🗑️ (trash) for "trashing" the header or with 📜 (scroll) for keeping it. |
|
🗑️ |
|
🗑️ (the emoji is called "wastebasket" in my case) 🤷 |
|
I just copy & pasted his 🗑️. |
|
The beauty of the header is that it is clear and easy to read in plain text. Is the alternative to rely on README.MD? The problem with that is the file is difficult to read at the CLI. (I'm sure some of us don't want to fire up a web browser just to read README.MD when we're editing regex data files 🙂) I'd still vote to bin it and centralise the header info, though 🗑️ (bin) |
|
I was just thinking of plain text, as it is now, and call it |
|
Why is it difficult to read? Most editors have highlighting for markdown. |
You can type |
|
🗑️ |
|
@theseion It looks like a mess due to the formatting. Looks lovely in HTML, but a mess at the CLI. Compared to the header in each |
brew install ronn && ronn -m util/regexp-assemble/README.mdOr I can generate the man page, put it beside the markdown file and you could do man util/regexp-assemble/README.1Would that help? |
|
@RedXanadu here's the README with formatting that can be properly formatted by ronn. Doesn't look too bad :) |
|
Yeah, we can make it look pretty, I was just making the point that the existing headers are good because they are easy to read in plain text already. We can make the README file look nice in a PDF or as HTML, of course, but we're sacrificing the plain text readability of the existing headers by removing them. I still think it is a good idea centralise/remove the headers, as suggested, I just wanted to raise the point :) |
|
Fair enough :) Thanks everyone for voting. I will close this PR and open a new one to remove the headers. |
The header comment in the regexp-assemble data files was no longer in
sync with the implementation after the merge of the improvements to the
preprocessing engine of regexp-assemble.
Replaces #2545 (comment) for v4.1/dev