Giter VIP home page Giter VIP logo

Comments (3)

AnneTheAgile avatar AnneTheAgile commented on May 13, 2024

I love to help add docs to code but don't know about GoDoc.
Here are some References on how to write GoDoc.
[0] Intro for Pythonistas.
http://golang-for-python-programmers.readthedocs.org/en/latest/doc.html
[1] Possibly the most complete tutorial, this item originated as blog post and became a git repo with working examples.
http://blog.natefinch.com/2014/04/effective-godoc.html
https://github.com/natefinch/godocgo
https://godoc.org/code.google.com/p/go.tools/cmd/godoc
[2] One pager with examples and tips.
https://godoc.org/github.com/fluhus/godoc-tricks
[3] Docs for test, eg if write documentation tests.
http://golang.org/pkg/testing/
[4] Other posts.
http://blog.golang.org/godoc-documenting-go-code
http://www.goinggo.net/2013/06/documenting-go-code-with-godoc.html
[5] Git commit of updating some docs per godoc standards.
https://gitorious.org/marc21-go/marc21/commit/f4f00cdfb56d32e6e196b565bd215245e3c0fd97
[6] No official full docs exist per my research.
[7] Free EBook on Go.
http://www.golangbootcamp.com/
// AnneTheAgile , here and there via CodeTriage.com

from cayley.

barakmich avatar barakmich commented on May 13, 2024

@AnneTheAgile Would love the help! The GoDoc bit is one thing for sure, but there's regular documentation that could use some help from writers too. An exposition on getting started, using Visualize, etc, within docs/ would be great too! (Overview.md is there but it could always use help)

from cayley.

kortschak avatar kortschak commented on May 13, 2024

To extend on this; doc comments can be refined into good godoc during review. Just picking a package and adding doc comments to exported functions, types and methods (and the package decl) is a start in this process.

As a tip, running an instance of godoc started by godoc -http=:6060 and reviewing your rendered documentation in the browser is a good way of both writing nice documentation and learning how to use the godoc system.

from cayley.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.