doc: mild doc improvements #4676
Conversation
Update the TC members list. Add a link to the online godoc in the Contribute section. Try and improve package descriptions (in the router only for now) to make the code easier to navigate with godoc.
|
This change is |
There was a problem hiding this comment.
Reviewed 7 of 7 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @jiceatscion)
router/cmd/router/main.go line 15 at r1 (raw file):
// limitations under the License. // Router is a SCION border router daemon
The daemon word could be confusing here, as there is also the SCION daemon
Code quote:
Router is a SCION border router daemonI had a plan (currently on hold) to use that; someone else might want to.
There was a problem hiding this comment.
Reviewable status: 6 of 10 files reviewed, 1 unresolved discussion (waiting on @lukedirtwalker)
router/cmd/router/main.go line 15 at r1 (raw file):
Previously, lukedirtwalker (Lukas Vogel) wrote…
The daemon word could be confusing here, as there is also the SCION daemon
Ok. Rephrased; although "daemon" is the conscerated term for Unix system processes. May be it's the "SCION daemon that could use a more specific name :-).
There was a problem hiding this comment.
Reviewed 4 of 4 files at r2, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @jiceatscion)
Update the TC members list. Add a link to the online godoc in the Contribute section. Try and improve package descriptions (in the router only for now) to make the code easier to navigate with godoc.