search

batfish / pybatfish

Python client for Batfish: https://github.com/batfish/batfish
Apache License 2.0
206 stars 51 forks source link

docs: document PathConstraints and HeaderConstraints properties properly #690

Open dhalperi opened 3 years ago

dhalperi commented 3 years ago

If I look at the docs for bfq.reachability, the DispositionSpec link goes to a page explaining the specifier.

However, the HeaderConstraints link goes to python documentation instead of a custom documentation page. Same for Path. This makes it pretty hard on our users (Rick Donato on Slack, this time)

ratulm commented 3 years ago

What is the ideal here? Header and Path constraints are classes in Python, so the documentation takes them there (as it does for Flow, Trace, etc.) DispositionSpec is a string from Python perspective.

Dan - Are you imagining that we create custom pages for Header and Path constraints, instead of, say, enhancing the python documentation of those classes?

On Mon, Nov 9, 2020 at 9:05 AM Dan Halperin notifications@github.com wrote:

Assigned #690 https://github.com/batfish/pybatfish/issues/690 to @ratulm https://github.com/ratulm.

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/batfish/pybatfish/issues/690#event-3974833679, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABEBDNAZATVYOUMUVFNZ3OLSPAOL5ANCNFSM4TPTTCEQ .

dhalperi commented 3 years ago

Header and Path Constraints have specs in them. Users should be able to get to those spec documentations in exactly the same way as if the spec was a top-level parameter.