Jon, > So, I might caution that this runs the risk of introducing a whole bunch > of complexity and dependency where we might not need more. We > need better writing and a willingness to write more complete sentences > with an eye toward understanding that the details are maybe not yet > obvious to the API user. That is, we need better content, not a more > complex system to manage the content.
Yes, I think that's exactly the problem. We don't need more "documentation" that the field @is_add when true means add... We need more background, intention, examples. It would be interesting if someone could have taken one VPP API and generated the "perfect" example, which we then could use as a pattern for others. I do like the Python docs approach. restructured text, separate git repo. But I'm flexible... Cheers, Ole
signature.asc
Description: Message signed with OpenPGP
_______________________________________________ vpp-dev mailing list vpp-dev@lists.fd.io https://lists.fd.io/mailman/listinfo/vpp-dev
