21/04/2021 12:21, Mcnamara, John: > From: Walsh, Conor <conor.wa...@intel.com> > > Currently the documentation describes how to add code snippets to the docs > > using code blocks. This can be problematic as the code snippets in the > > docs may fall out of sync with the actual code it is referencing within > > DPDK. This patch adds instructions to the contribution guide about how to > > include code in the docs using literalinclude which will dynamically get > > the code from source when the docs are generated. This will help to ensure > > that the code within the docs is up to date and not out of sync with the > > actual code. > > This is a very good suggestion and I think we should encourage doc writers > to use this when including code in the documentation.
Yes, and we should try to clean-up existing code snippets.
