Small documentation fixes #2
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
it seems when a comment ends with a period, the reest of the comment is ignored, which defeats the purpose of the comment!
BobyMCbobs
reviewed
Nov 15, 2021
| @@ -20,55 +20,55 @@ func GetEnvOrDefault(envName string, defaultValue string) (output string) { | |||
| return output | |||
| } | |||
|
|
|||
| // GetAppEnvFile ... | |||
| // GetAppEnvFile - | |||
There was a problem hiding this comment.
Why a hyphen?
Perhaps, if I put all of the comments on the same line this will not be needed?
There was a problem hiding this comment.
oh, the hyphen was to offer a replacement character for the three dots, as i assumed you were using them for typographical/formatting reasons. They can be removed easy enough, but the three dots for whatever reasons marks the end of a go comment within go's tooling.
There was a problem hiding this comment.
the three dots for whatever reasons marks the end of a go comment within go's tooling
I didn't know that! But that explains why in the LSP, it may not show the rest of the info about the comment!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These are a couple fixes for issues that came up when exploring this code. In the readme for the exporter, there is a reference to an example output that does not show due to how github parses org files. I removed the
#+RESULTStag so that the output shows. I also removed instances where...appeared at the end of a function comment, as the go tooling ignores commented lines after these dots.