Improve showpaths documentation

[worxli]

Fixes #2038

---

This change is 

[scrye]

Reviewed 1 of 1 files at r1.
Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions (waiting on @scrye and @worxli)

---

go/tools/showpaths/paths.go, line 141 at r1 (raw file):

Usage: showpaths [flags]

Showpaths lists available paths between SCION ASes. Paths might be taken from a cache and therefore

Maybe use lowercase at start? Or just start with "Lists available paths ...".

---

go/tools/showpaths/paths.go, line 142 at r1 (raw file):

Showpaths lists available paths between SCION ASes. Paths might be taken from a cache and therefore
may be unhealthy. To check if paths are health, use -p to probe the paths and print its statuses.

I don't know if external users have the same concept of "path health" we do. Maybe rephrase to the following, s.t. it's a bit more obvious what path health means?

Paths might be retrieved from a local cache, and they might not forward traffic successfully (for example, if a network link went down). To probe if the paths are healthy, use -p.

Also, some typos:
s/health/healthy
s/its/their

[worxli]

Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions (waiting on @scrye)

---

go/tools/showpaths/paths.go, line 141 at r1 (raw file):

Previously, scrye (Sergiu Costea) wrote…

Maybe use lowercase at start? Or just start with "Lists available paths ...".

Done.

---

go/tools/showpaths/paths.go, line 142 at r1 (raw file):

Previously, scrye (Sergiu Costea) wrote…

I don't know if external users have the same concept of "path health" we do. Maybe rephrase to the following, s.t. it's a bit more obvious what path health means?

Paths might be retrieved from a local cache, and they might not forward traffic successfully (for example, if a network link went down). To probe if the paths are healthy, use -p.

Also, some typos:
s/health/healthy
s/its/their

Done.

[scrye]

Reviewed 1 of 1 files at r2.
Reviewable status: complete! all files reviewed, all discussions resolved