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.

Sign up for GitHub

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

Jump to bottom

[Lint] Suggest appropriate comment style in .cdc files #13

Open
franklywatson opened this issue Sep 16, 2022 · 0 comments
Open

[Lint] Suggest appropriate comment style in .cdc files #13

franklywatson opened this issue Sep 16, 2022 · 0 comments
Labels
Feature Good First Issue Help Wanted A feature we want the help from community SC-Eng

Comments

@franklywatson
Copy link

Description

Linter should inform users that

  1. Top level comments and comments for types, fields, events, and functions should use /// which will ensure it gets picked up by the Cadence doc autogeneration
  2. Regular comments within functions should only use two slashes
@turbolent turbolent added the Help Wanted A feature we want the help from community label Oct 12, 2022
@turbolent turbolent changed the title [Linter] Suggest appropriate comment style in .cdc files [Lint] Suggest appropriate comment style in .cdc files Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature Good First Issue Help Wanted A feature we want the help from community SC-Eng
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@turbolent @franklywatson