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

Scilla style guide #168

Open
jubnzv opened this issue Sep 30, 2022 · 0 comments
Open

Scilla style guide #168

jubnzv opened this issue Sep 30, 2022 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@jubnzv
Copy link
Contributor

jubnzv commented Sep 30, 2022

After introducing scilla-fmt, we should describe the recommended Scilla style guide used by the formatter.

Changes in Zilliqa/scilla#1172 add a special meaning to some of the comments at the top level:

scilla_version 0
(* File comment that describes what this contract module does. *)
import BoolUtils

(* Library comment *)
library ExampleLib

(* Library function comment *)
let a = Uint32 1

(* Contract comment *)
contract ExampleContr

(* Component comment *)
procedure foo()
end

This technical decision is required for the implementation, and it allows us to do something interesting using this comments structure. For example, we may want to implement an ocamldoc-style documentation generator or something like this.

So, we should somehow document where these comments should be placed and their meaning.

@jubnzv jubnzv added enhancement New feature or request help wanted Extra attention is needed labels Sep 30, 2022
@jubnzv jubnzv added this to the Scilla 0.13.0 milestone Oct 6, 2022
@jjcnn jjcnn modified the milestones: Scilla 0.13.0, Scilla 0.14.0 Dec 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants