Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

docs: heading option only working with separate_signature #767

Copy link
Copy link
Closed
@TSeverinDSE

Description

@TSeverinDSE
Issue body actions

The description of the heading option does not mention, that this option only works when also separate_signatureis set to true.

Relevant code snippets

Compare jinja code (here only for modules, equally for other types):

{% if config.separate_signature %}
  <span class="doc doc-object-name doc-module-name">{{ config.heading if config.heading and root else module_name }}</span>
{% else %}
  <code>{{ module_name }}</code>
{% endif %}

Documentation Sections:

Further comments

I filed this as a documentation bug, since this is the easiest to resolve, however I'd also consider this a bug/feature request, to have the heading option working even without separate_signature option. On request I can add another issue for that.

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Morty Proxy This is a proxified and sanitized view of the page, visit original site.