Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blank Lines in eos_cli_con_gen device documentation #428

Closed
aphillipps opened this issue Dec 7, 2020 · 1 comment · Fixed by #435
Closed

Blank Lines in eos_cli_con_gen device documentation #428

aphillipps opened this issue Dec 7, 2020 · 1 comment · Fixed by #435
Assignees
Labels
role: eos_cli_config_gen issue related to eos_cli_config_gen role type: documentation Improvements or additions to documentation
Milestone

Comments

@aphillipps
Copy link
Contributor

aphillipps commented Dec 7, 2020

Issue Type

Blank lines when features not defined

  • Documentation Report

Summary

The blank line between the different feature documentation or documentation tables should be added after the IF statement and not before otherwise there will be as many blank lines as non-defined features.

Role or Module Name

eos_cli_config_gen

Steps to reproduce

{%  if %}
...
{%   endif %}

{%   if router_bgp.vlans is defined and router_bgp.vlans is not none %}
**VLAN Based:**
...
{%   endif %}

In the case above if router_bgp.vlans is not defined, it will still add a blank line. If there are severals items that are not defined it will add a blank line for every item.

Expected results

Instead it should be:

{%  if %}
...
{%   endif %}
{%   if router_bgp.vlans is defined and router_bgp.vlans is not none %}

**VLAN Based:**
...
{%   endif %}
@aphillipps aphillipps added type: documentation Improvements or additions to documentation role: eos_cli_config_gen issue related to eos_cli_config_gen role labels Dec 7, 2020
@aphillipps aphillipps added this to the v1.1.3 milestone Dec 7, 2020
@titom73 titom73 mentioned this issue Dec 7, 2020
12 tasks
@titom73 titom73 self-assigned this Dec 8, 2020
titom73 added a commit to noredistribution/avd that referenced this issue Dec 8, 2020
- Remove blank line when conditions are not met
- Set default message when missing
- Fix some rendering issues
@titom73 titom73 linked a pull request Dec 9, 2020 that will close this issue
12 tasks
@titom73
Copy link
Contributor

titom73 commented Dec 9, 2020

Closed as merged with PR #435

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
role: eos_cli_config_gen issue related to eos_cli_config_gen role type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants