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

Document single-line and multi-line commenting for Bend users #692

Open
kings177 opened this issue Aug 21, 2024 · 1 comment
Open

Document single-line and multi-line commenting for Bend users #692

kings177 opened this issue Aug 21, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@kings177
Copy link
Member

kings177 commented Aug 21, 2024

We need to create user documentation for the commenting feature.

Tasks:

Create a section in the documentation that explains how to use comments in bend. This should cover both single-line and multi-line comments.

Key points to include:

1. Single-line comments:

  • Syntax: Use # at the beginning of a line or after code
  • Example Usage

2. Multi-line comments:

  • Syntax: Use #{ to start and #} to end a multi-line comment
  • Example usage
  • Mention that they can span multiple lines
@developedby
Copy link
Member

We should also meant that documentation for functions is meant to be written as a multiline comment rightt above the function. Eg:

#{
  Returns the list with the elements in the reverse order.
}#
List/reverse(xs):
  ...

For now it doesn't to anything, but that's how we want to use it

@developedby developedby added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 22, 2024
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants