Re: [PATCH] PerfReversibleFlowMixin.py: Fixup docs

[Jan Tluka]

Thu, Sep 17, 2020 at 10:26:58PM CEST, pgagne(a)redhat.com wrote:
> From: Perry Gagne <pgagne(a)redhat.com&gt;
>
> Did some cleanup of the docstrings and add sphinx rst files
>
> Signed-off-by: Perry Gagne <pgagne(a)redhat.com&gt;
> ---
>  .../config_mixin_classes/perf_reverse_mixin.rst    |  6 ++++++
>  docs/source/config_mixins.rst                      |  1 +
>  .../ENRT/ConfigMixins/PerfReversibleFlowMixin.py   | 14 ++++++--------
>  3 files changed, 13 insertions(+), 8 deletions(-)
>  create mode 100644 docs/source/config_mixin_classes/perf_reverse_mixin.rst
>
> diff --git a/docs/source/config_mixin_classes/perf_reverse_mixin.rst
> b/docs/source/config_mixin_classes/perf_reverse_mixin.rst
> new file mode 100644
> index 0000000..6d0e726
> --- /dev/null
> +++ b/docs/source/config_mixin_classes/perf_reverse_mixin.rst
> @@ -0,0 +1,6 @@
> +PerfReversibleFlowMixin
> +================
> +
> +.. autoclass::
> lnst.Recipes.ENRT.ConfigMixins.PerfReversibleFlowMixin.PerfReversibleFlowMixin
> +    :members:
> +    :show-inheritance:
> diff --git a/docs/source/config_mixins.rst b/docs/source/config_mixins.rst
> index 8558fc9..b766a0c 100644
> --- a/docs/source/config_mixins.rst
> +++ b/docs/source/config_mixins.rst
> @@ -12,3 +12,4 @@ ENRT Config Mixins
>      config_mixin_classes/dev_interrupt_mixin
>      config_mixin_classes/parallel_stream_qdisc_mixin
>      config_mixin_classes/pause_frames_mixin
> +    config_mixin_classes/perf_reverse_mixin.rst
> diff --git a/lnst/Recipes/ENRT/ConfigMixins/PerfReversibleFlowMixin.py
> b/lnst/Recipes/ENRT/ConfigMixins/PerfReversibleFlowMixin.py
> index a5bcfad..48210d0 100644
> --- a/lnst/Recipes/ENRT/ConfigMixins/PerfReversibleFlowMixin.py
> +++ b/lnst/Recipes/ENRT/ConfigMixins/PerfReversibleFlowMixin.py
> @@ -9,19 +9,17 @@ class PerfReversibleFlowMixin(object):
>  
>      For example:
>  
> -    SimpleNetworkRecipe is symmetrical since both endpoints are of the same type
> -    (both plain interfaces).
> +        SimpleNetworkRecipe is symmetrical since both endpoints are of the same type
> (both plain interfaces).
>  
> -    TeamRecipe is asymmetrical because one endpoint is a team device and the
> -     other is a plain interface.
> +        TeamRecipe is asymmetrical because one endpoint is a team device and the other is
> a plain interface.
>  
> -    So TeamRecipe could use this mixin to indicate that is can be reversed.
> +    So TeamRecipe could use this mixin to indicate that the flow of traffic can be
> reversed.
>  
> -    This can be controlled by the perf_reverse parameter:
> +    This can be controlled by the `perf_reverse` parameter:
>  
>      :param perf_reverse:
> -        Parameter used by the :any:`generate_flow_combinations` generator. To
> -        specify that the flow of traffic between the endpoints should be reversed.
> +        Parameter used by the :any:`generate_flow_combinations` generator.
> +        To specify that the flow of traffic between the endpoints should be reversed.
>      :type perf_reverse: :any:`BoolParam` (default False)
>      """
>      perf_reverse = BoolParam(default=False)
> -- 
> 2.26.2
> _______________________________________________
> LNST-developers mailing list -- lnst-developers(a)lists.fedorahosted.org
> To unsubscribe send an email to lnst-developers-leave(a)lists.fedorahosted.org
> Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
> List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
> List Archives:
> https://lists.fedorahosted.org/archives/list/[e-mail]...
Acked-by: Jan Tluka <jtluka(a)redhat.com&gt;