Page MenuHomePhorge

Add documentation for cowsay
ClosedPublic

Authored by Sten on Sep 5 2023, 16:29.

Details

Summary

Cowsay is great, but what if you want to talk like a koala?

This diff adds diviner documentation on how to use the additional templates in externals/cowsay/cows/

Test Plan

Diff Detail

Repository
rP Phorge
Branch
cowsayDocs (branched from master)
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 835
Build 835: arc lint + arc unit

Event Timeline

Sten requested review of this revision.Sep 5 2023, 16:29
___________________________ < Please approve this diff! > --------------------------- \ . . \ / `. .' " \ .---. < > < > .---. \ | \ \ - ~ ~ - / / | _____ ..-~ ~-..-~ | | \~~~\.' `./~~~/ --------- \__/ \__/ .' O \ / / \ " (_____, `._.' | } \/~~~/ `----. / } | / \__/ `-. | / | / `. ,~~| ~-.__| /_ - ~ ^| /- _ `..-' | / | / ~-. `-. _ _ _ |_____| |_____| ~ - . _ _ _ _ _>

lol

Just a question. Why under differential and not related to Remarkup?

Sten planned changes to this revision.Sep 5 2023, 19:42

lol

Just a question. Why under differential and not related to Remarkup?

Yes, that would be better. And then add links to from the differential guide. Watch this space...

Cowsay documentation moved to Remarkup section
Links to Remarkup section added to Differential documentation

Cowsay documentation moved to Remarkup section
Links to Remarkup section added to Differential documentation

Nice! Just few inline tips

src/docs/user/userguide/differential_faq.diviner
54

(Double space here)

56–57

We can put "." at the end of the phrase.

-Phabricator
+Phorge

Also maybe taking inspiration from remarkup.diviner:

-"similar to Markdown"
+"similar to other markup languages like Markdown and Wiki markup"

src/docs/user/userguide/remarkup_cowsay.diviner
18–27

Maybe we can just render the thing, quoted. Example:

> cowsay{{{Great work!}}}
35–48

Also here, maybe we can just quote and render

> cowsay(cow='tux'){{{Great work!}}}

Updated differential_faq.diviner as per review.

I disagree with using cowsay to render the output to show what cowsay should generate for the following reasons:

  • This would remove the demonstration of what the output looks like when the document is read as plain text - a primary purpose of markdown is that you can read the document directly, you don't have to view a rendered version over the web.
  • If there was a fault, you wouldn't know what it's supposed to generate.
Sten marked 2 inline comments as done.Sep 6 2023, 11:19

Yeah why not, thanks

Please wait 2-3 days before landing, so other people can share useful tips

This revision is now accepted and ready to land.Sep 7 2023, 08:18

Please wait 2-3 days before landing, so other people can share useful tips

Sure thing - I'll leave it till after 14th September.

Any suggestions or additions, bring it on!

_______________________ ( Documentation is cool ) ----------------------- o o .--. |o_o | |:_/ | // \ \ (| | ) /'\_ _/`\ \___)=(___/

Add a note about figlet

No further changes requested in 13 days, so am going to land this diff.

This revision was automatically updated to reflect the committed changes.