Skip to content

docs: fix module schema property description for object types #7049

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.

Sign up for GitHub

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

Open
sundeep8967 wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −4
Open

docs: fix module schema property description for object types #7049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions doc/rtd/templates/module_property.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,22 @@
{{prefix ~ ' '}}{{ line }}
{% endfor -%}
{%- endmacro -%}
{% set ns = namespace(is_obj_type=false) -%}
{% set ns = namespace(is_obj_type=false, is_list_type=false) -%}
{% for alt_schema in prop_cfg.get("oneOf", []) -%}
{% if ('properties' in alt_schema or 'patternProperties' in alt_schema) %}{% set ns.is_obj_type = true -%}{% endif -%}
{% endfor -%}
{% if ('properties' in prop_cfg or 'patternProperties' in prop_cfg) %}{% set ns.is_obj_type = true -%}{% endif -%}
{% for key, val in prop_cfg.get('items', {}).items() -%}
{% if key in ('properties', 'patternProperties') -%}{% set ns.is_obj_type = true -%}{% endif -%}
{% if key in ('properties', 'patternProperties') -%}{% set ns.is_obj_type = true -%}{% set ns.is_list_type = true -%}{% endif -%}
{% if key == 'oneOf' -%}
{% for oneOf in val -%}
{% if ('properties' in oneOf or 'patternProperties' in oneOf ) -%}{% set ns.is_obj_type = true -%}{% endif -%}
{% if ('properties' in oneOf or 'patternProperties' in oneOf ) -%}{% set ns.is_obj_type = true -%}{% set ns.is_list_type = true -%}{% endif -%}
{% endfor -%}
{% endif -%}
{% endfor -%}
{% if ns.is_obj_type -%}
{% if ns.is_list_type -%}
{% set description = description ~ " Each object in **" ~ name ~ "** list supports the following keys:" -%}
{% elif ns.is_obj_type -%}
{% set description = description ~ " The **" ~ name ~ "** object supports the following keys:" -%}
{% endif -%}
{{ print_prop(name, types, description, deprecated, changed, prefix ) -}}
Loading