search

fujiapple852 / trippy

A network diagnostic tool
https://trippy.cli.rs
Apache License 2.0
3.8k stars 82 forks source link

doc: make as searchable #1339

Closed c-git closed 1 month ago

c-git commented 1 month ago

Makes it easier for users to lookup as AS is hard to search for

fujiapple852 commented 1 month ago

My only comment is on the cmd.rs change, as this makes --tui-as-mode the new longest line output by trip -h:

      --tui-as-mode <TUI_AS_MODE>                          How to render Anonymous System (AS) information [default: asn] [possible values: asn, prefix, country-code, registry, allocated, name]

The output is a bit of inconsistent at the moment, we don't define some of the terms here (i.e. MPLS) though we do define some (i.e. ECMP). On balance I think I favour brevity for command line help output, but I'm persuadable either way.

Fine with everything else.

c-git commented 1 month ago

I don't feel strongly about changing that one. I don't really mind not defining MPLS but I do mind for AS. The reason is MPLS is very easy to Google while AS is a lot harder because "as" is a word.

But thinking about it more, I'm ok with it being long. It will just wrap. It's probably better for the user to be able to get useful information from it. Brief but not lacking necessary info is where I guess we should aim for (necessary here referring to things that are hard to find based on what we did include).

fujiapple852 commented 1 month ago

Tweaked slightly to standardize on autonomous system (AS) (just a change to the casing). I also rebased and squashed the last two commits.

fujiapple852 commented 1 month ago

Seems I had some typos ("Anonymous System (AS)") in there as well, all fixed.