search

napalm-automation / napalm

Network Automation and Programmability Abstraction Layer with Multivendor support
Apache License 2.0
2.23k stars 551 forks source link

Inconsistent documentation on ping and traceroute #394

Open ktbyers opened 7 years ago

ktbyers commented 7 years ago

How is the getters support matrix documentation built?

is_alive, ping, and traceroute shouldn't be in this matrix (i.e. only methods that begin with get_ should be in this matrix).

Also ping and traceroute have inconsistent information between what is in the getters matrix and what is in the "Other Methods" section?

ktbyers commented 7 years ago

Corrected inconsistencies here:

https://github.com/napalm-automation/napalm/pull/395

We should still correct having the same information in two places (i.e. in the getters and other methods sections).

dbarrosop commented 7 years ago

We should get rid of the "other methods". The matrix is built here:

https://github.com/napalm-automation/napalm/blob/develop/docs/conf.py#L309

And what it basically does is clone all drivers, run the tests and build the table based on the result of the tests. So the table should be consistent with the tests and should report if we break something.