Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doccords for arms #5781

Closed
drbeefsupreme opened this issue May 24, 2022 · 1 comment
Closed

Doccords for arms #5781

drbeefsupreme opened this issue May 24, 2022 · 1 comment
Assignees

Comments

@drbeefsupreme
Copy link
Contributor

drbeefsupreme commented May 24, 2022

"arm docs"
Docs written above the arm, e.g.

:>  This is an arm doc
++  foo

"product docs"
Docs written after the name of the arm, e.g.

++  foo
:>  This is a product doc

"default arm in core docs"
If an arm builds a core that has an arm named $, then the arm doc of that arm, e.g.

++  foo
  |%
  :>  This is docs on a default arm
  ++  $  ~

These all currently mostly work, but some edge cases fail. Lots of product cases have yet to be written, but there are some parser issues when multiple cases are combined.

@drbeefsupreme
Copy link
Contributor Author

Not worth addressing edge cases until #5770 is resolved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant