urbit / urbit.org

The source for urbit.org
https://urbit.org
MIT License
93 stars 197 forks source link

Irregular form syntax docs were lost in transition #809

Closed ohAitch closed 3 years ago

ohAitch commented 8 years ago
~wolser-lopwyl= i've noticed that there are many usage examples/etc in the hoon
~wolser-lopwyl= reference that use irregular syntax in the examples which the
~wolser-lopwyl= reader may not have been exposed to yet
~wolser-lopwyl= makes it very difficult to decipher the docs sometimes - are
~wolser-lopwyl= there plans for an effort of some kind to 'sanitize' the docs,
--------[5.025]
~wolser-lopwyl= ie: add "long form" exmaples, reduce irregular syntax usage,
~wolser-lopwyl= etc?
~wolser-lopwyl= example: i still haven't come across docs explaining the
~wolser-lopwyl= backtick syntax, so every time i see that in an example i'm
~wolser-lopwyl= unsure exactly what it's illustrating
--------[5.030]
          ~fyr= did the irregular syntax doc not make the cut?
~wolser-lopwyl= what irregular syntax doc?
joemfb commented 8 years ago

The irregular form of :cast (`@t%a) was on the:like` page... Fixed in urbit/docs#25

joemfb commented 8 years ago

Here's some relevant links:

And also, linked from the glossary PR:

http://www.bayleshanks.com/?action=browse&id=notes-computer-programming-hoon-hoonCheatSheet&raw=1

joemfb commented 8 years ago

And, while I'm at it, the odor cheat-sheet is really good too: https://github.com/urbit/docs/blob/8c634ff17e7ada8584069ee7018490471b112fb2/docs/programming/cheat-sheets/odors.md

galenwp commented 8 years ago

That odors sheet looks like it just needs to be tested / normalized to the current form. If people think it's useful, let's include it.

galenwp commented 8 years ago

I feel like some of those irregular forms have changed, but the cheat sheet was intended to be included in these docs (to my memory). That's a great thing to have on hand for day to day programming in hoon.

hoclun-rigsep commented 8 years ago

Where in the hierarchy do we want a glossary of irregular forms?

galenwp commented 8 years ago

Off the cuff I'd say /hoon/twig/irregular.md (or similar). @cgyarvin, what do you think?

Fang- commented 6 years ago

We have irregular syntax docs now.