Skip to content

Commit 6133b2a

Browse files
committed
fix: De-duplicate summary sections when they already exist in the docstring
Issue-12: #12
1 parent 27a98cc commit 6133b2a

4 files changed

Lines changed: 56 additions & 48 deletions

File tree

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
{% with section = obj.attributes
2-
|filter_objects(
3-
filters=config.filters,
4-
members_list=members_list,
5-
inherited_members=config.inherited_members,
6-
keep_no_docstrings=config.show_if_no_docstring,
7-
)
8-
|order_members(config.members_order, members_list)
9-
|as_attributes_section(check_public=not members_list)
10-
%}
11-
{% if section %}{% include "docstring/attributes.md.jinja" with context %}{% endif %}
12-
{% endwith %}
1+
{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "attributes") | list %}
2+
{% with section = obj.attributes
3+
|filter_objects(
4+
filters=config.filters,
5+
members_list=members_list,
6+
inherited_members=config.inherited_members,
7+
keep_no_docstrings=config.show_if_no_docstring,
8+
)
9+
|order_members(config.members_order, members_list)
10+
|as_attributes_section(check_public=not members_list)
11+
%}
12+
{% if section %}{% include "docstring/attributes.md.jinja" with context %}{% endif %}
13+
{% endwith %}
14+
{% endif %}
Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
{% with section = obj.classes
2-
|filter_objects(
3-
filters=config.filters,
4-
members_list=members_list,
5-
inherited_members=config.inherited_members,
6-
keep_no_docstrings=config.show_if_no_docstring,
7-
)
8-
|order_members(config.members_order, members_list)
9-
|as_classes_section(check_public=not members_list)
10-
%}
11-
{% if section %}{% include "docstring/classes.md.jinja" with context %}{% endif %}
12-
{% endwith %}
1+
{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "classes") | list %}
2+
{% with section = obj.classes
3+
|filter_objects(
4+
filters=config.filters,
5+
members_list=members_list,
6+
inherited_members=config.inherited_members,
7+
keep_no_docstrings=config.show_if_no_docstring,
8+
)
9+
|order_members(config.members_order, members_list)
10+
|as_classes_section(check_public=not members_list)
11+
%}
12+
{% if section %}{% include "docstring/classes.md.jinja" with context %}{% endif %}
13+
{% endwith %}
14+
{% endif %}
Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
{% with section = obj.functions
2-
|filter_objects(
3-
filters=config.filters,
4-
members_list=members_list,
5-
inherited_members=config.inherited_members,
6-
keep_no_docstrings=config.show_if_no_docstring,
7-
)
8-
|order_members(config.members_order, members_list)
9-
|as_functions_section(check_public=not members_list)
10-
%}
11-
{% if section %}{% include "docstring/functions.md.jinja" with context %}{% endif %}
12-
{% endwith %}
1+
{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "functions") | list %}
2+
{% with section = obj.functions
3+
|filter_objects(
4+
filters=config.filters,
5+
members_list=members_list,
6+
inherited_members=config.inherited_members,
7+
keep_no_docstrings=config.show_if_no_docstring,
8+
)
9+
|order_members(config.members_order, members_list)
10+
|as_functions_section(check_public=not members_list)
11+
%}
12+
{% if section %}{% include "docstring/functions.md.jinja" with context %}{% endif %}
13+
{% endwith %}
14+
{% endif %}
Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
{% with section = obj.modules
2-
|filter_objects(
3-
filters=config.filters,
4-
members_list=members_list,
5-
inherited_members=config.inherited_members,
6-
keep_no_docstrings=config.show_if_no_docstring,
7-
)
8-
|order_members("alphabetical", members_list)
9-
|as_modules_section(check_public=not members_list)
10-
%}
11-
{% if section %}{% include "docstring/modules.md.jinja" with context %}{% endif %}
12-
{% endwith %}
1+
{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "modules") | list %}
2+
{% with section = obj.modules
3+
|filter_objects(
4+
filters=config.filters,
5+
members_list=members_list,
6+
inherited_members=config.inherited_members,
7+
keep_no_docstrings=config.show_if_no_docstring,
8+
)
9+
|order_members("alphabetical", members_list)
10+
|as_modules_section(check_public=not members_list)
11+
%}
12+
{% if section %}{% include "docstring/modules.md.jinja" with context %}{% endif %}
13+
{% endwith %}
14+
{% endif %}

0 commit comments

Comments
 (0)