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

Add godocs on the existing configuration #36

Merged
merged 1 commit into from
Dec 8, 2023
Merged

Add godocs on the existing configuration #36

merged 1 commit into from
Dec 8, 2023

Conversation

mvach
Copy link
Contributor

@mvach mvach commented Dec 6, 2023

No description provided.

Copy link
Member

@selzoc selzoc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love this! It would be great if the comments followed godoc conventions - in particular

Notice this comment is a complete sentence that begins with the name of the element it describes. This important convention allows us to generate documentation in a variety of formats, from plain text to HTML to UNIX man pages, and makes it read better when tools truncate it for brevity, such as when they extract the first line or sentence.

@mvach
Copy link
Contributor Author

mvach commented Dec 6, 2023

I love this! It would be great if the comments followed godoc conventions - in particular

Notice this comment is a complete sentence that begins with the name of the element it describes. This important convention allows us to generate documentation in a variety of formats, from plain text to HTML to UNIX man pages, and makes it read better when tools truncate it for brevity, such as when they extract the first line or sentence.

Actually I'm so new to the golang universe, that I wasn't aware of such conventions. I'll carefully read and apply them. Thx for that hint.

@mvach
Copy link
Contributor Author

mvach commented Dec 7, 2023

I hope this next version is a better one

Copy link
Contributor

@ramonskie ramonskie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Member

@selzoc selzoc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :shipit:

@selzoc selzoc merged commit 6caa954 into master Dec 8, 2023
5 checks passed
@selzoc selzoc deleted the add-docs branch December 8, 2023 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants