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

handle newlines in docs generation for exported fields #548

Closed
arichardet opened this issue Dec 16, 2016 · 0 comments
Closed

handle newlines in docs generation for exported fields #548

arichardet opened this issue Dec 16, 2016 · 0 comments
Labels
Projects

Comments

@arichardet
Copy link
Contributor

Doc extraction for handling newlines in comments for exported fields results in creating a bullet for each newline. We should handle this in extract.go.

Here is sample output for file.fetch:

Exported Fields#
Here are the fields that are exported for use with ‘lookup’. Re-exported fields will have their own fields exported under the re-exported namespace.
> source (string) Source is the location of the file to fetch
> destination (string) Destination for the fetched file
> hash_type (string) HashType is the hash function used to generate the checksum hash
> hash (string) Hash is the checksum hash
> force (bool) Force indicates whether the file will be fetched if it already exists If true, the file will be fetched if:
> no checksum is provided
> the checksum of the existing file differs from the checksum provided
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
0.5.0
Ready to Ship
Development

No branches or pull requests

1 participant