Skip to content

docs: heading option only working with separate_signature #767

@TSeverinDSE

Description

@TSeverinDSE

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 working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    pFad - Phonifier reborn

    Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

    Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


    Alternative Proxies:

    Alternative Proxy

    pFad Proxy

    pFad v3 Proxy

    pFad v4 Proxy