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

text/template: add more package docs #13880

Open
thewhitetulip opened this issue Jan 8, 2016 · 4 comments
Open

text/template: add more package docs #13880

thewhitetulip opened this issue Jan 8, 2016 · 4 comments
Labels
Milestone

Comments

@thewhitetulip
Copy link

@thewhitetulip thewhitetulip commented Jan 8, 2016

We can add more comments to text/template package so the readers who use godoc will see somewhat more detailed material in the documentation rather than the sparse documentation which is currently present.

@bradfitz

This comment has been minimized.

Copy link
Contributor

@bradfitz bradfitz commented Jan 21, 2016

Which parts of text/template you would like to see more documentation on?

@bradfitz bradfitz added this to the Unplanned milestone Jan 21, 2016
@bradfitz bradfitz changed the title Adding more comments to text/template package per function text/template: add more package docs Jan 21, 2016
@thewhitetulip

This comment has been minimized.

Copy link
Author

@thewhitetulip thewhitetulip commented Jan 22, 2016

small concise examples about every function, I'll post a list soon

@pyros2097

This comment has been minimized.

Copy link

@pyros2097 pyros2097 commented Feb 11, 2016

+1. More documentation on using the template tag would be useful because people generally use one large template and insert stuff into it.

{{template "content" .Data}}
@thewhitetulip

This comment has been minimized.

Copy link
Author

@thewhitetulip thewhitetulip commented Feb 19, 2016

We can give examples for using the eq operator, for go1.6 considerably new documentation has been added like the range operator. I feel that the documentation for text/template should sound less like documentation documentation, meaning too much theoretical since a documentation is basically an official guide into the API of the language, it should be like Python's documentation, least amount of theory and all examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.