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

Formatting STS rules #340

Open
WhatisRT opened this issue Dec 19, 2023 · 0 comments
Open

Formatting STS rules #340

WhatisRT opened this issue Dec 19, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@WhatisRT
Copy link
Collaborator

WhatisRT commented Dec 19, 2023

The formatting of let seems weird to me and inconsistent across the document; I would suggest the following two versions to be applied uniformly and consistently:

  1. for very small binding, just keep it in the same line as the rule/constructor, e.g.
RULE: let x = 5 in ...
  ...
  1. for longer cases, always use the following format:
RULE: 
  let
    BINDING #1
    BINDING #2
    ...
    BINDING #k
  in
    ...

(if you cannot spare the two spaces caused by the suggested indentation, the problem lies elsewhere..)


While I'm at it, I saw some occurrences of the function arrow for rule hypotheses, which should be uniformly replaced with in my opinion and formatted the same way as LEDGER currently is, i.e.

RULE : let ... in
  ∙ HYPOTHESIS #1
  ∙ HYPOTHESIS #2
 
  ∙ HYPOTHESIS #n
    ────────────────────────────────
    CONCLUSION

(notice how the 'dots' lie outside and hypothesis, horizontal rule and conclusion are all lined up.

Originally posted by @omelkonian in #336 (comment)

@WhatisRT WhatisRT added the documentation Improvements or additions to documentation label Dec 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant