bug: type body in headers

[rafalkrupinski]

Description of the bug

When running with configuration

[tool.griffe2md]
show_signature_annotations= true
separate_signature = false

bodies of types are included in headers.

To Reproduce

Using #10 run

griffe2md src/griffe2md

Expected behavior

Bodies of types shouldn't count as signatures so they shouldn't be included

[pawamoy]

Thanks for the report 🙂 Not sure to understand, what's a "type body"? I tried looking at the output of griffe2md src/griffe2md but I don't see anything suspicious.

[rafalkrupinski]

the code of the whole class is included in title

[pawamoy]

I cannot see that in the output of griffe2md src/griffe2md, please provide a minimal reproducible example 🙂

[rafalkrupinski]

1. I've generated markdown for griffe2md with the default configuration to a file
2. then with the above configuration to another file
3. run diff on the two files

Sections for constants change as if the entire value was in the header, e.g.:

#### <code>

griffe2md.config.CONFIG_FILE_PATHS = (Path('.config/griffe2md.toml'), Path('config/griffe2md.toml'), Path('pyproject.toml'))</code>

Also, other headers change from name to `name`, not sure if that's desired.

[rafalkrupinski]

54c46
< ### griffe2md.config
---
> ### `griffe2md.config`
67c59
< #### griffe2md.config.CONFIG_FILE_PATHS
---
> #### <code>
69,82c61,63
< ```python
< CONFIG_FILE_PATHS = (
<     Path(".config/griffe2md.toml"),
<     Path("config/griffe2md.toml"),
<     Path("pyproject.toml"),
< )
< 
< ```
< 
< #### griffe2md.config.load_config
< 
< ```python
< load_config()
< ```
---
> griffe2md.config.CONFIG_FILE_PATHS = (Path('.config/griffe2md.toml'), Path('config/griffe2md.toml'), Path('pyproject.toml'))</code>
> 
> #### griffe2md.config.load_config() -> rendering.ConfigDict | None
89c70
< #### griffe2md.config.logger
---
> #### <code>

[pawamoy]

Thanks! I think we're just outputting extraneous new lines after <code> in a heading.

[pawamoy]

The reasoning behind wrapping headings in <code> or not is:

• if we separate the signature, then the heading is just the name, not needing <code>
• otherwise, we're showing code in the heading so it needs to be wrapped in <code>

But we could decide to always wrap the heading in <code> tags, WDYT?

[pawamoy]

You can try the main branch and let me know if it's better 🙂

[rafalkrupinski]

Thanks! I think we're just outputting extraneous new lines after <code> in a heading.

Since theoretically signatures apply only to functions, I just assumed it was an error to even include their values in headers. If it was my project, I'd just render function signatures (incl. methods).

Since you've asked, I guess always wrapping them in <code> makes sense and should make code simpler.