Include the best practice for documenting a Ballerina record in the style guide #8929
Labels
Area/LearnPages
Issues related to all the pages of the Learn section.
Category/Content
All written content related issues (Technical content, english language etc)
Type/Improvement
Improvements required on the website.
Description
ATM, the style guide does not specify what the best practice is for documenting a record: https://ballerina.io/learn/style-guide/annotations-documentation-and-comments/#documentation. Currently, there are two approaches to document a record.
The latter approach is used as a best practice within the Ballerina team. Even with the considered approach, it is yet unclear whether to leave a space between the fields for better readability. IMO, when a node has more metadata, having a space in between can enhance the readability of the code.
The text was updated successfully, but these errors were encountered: