Do not use title for objects containing only additionalProperties or patternProperties

[zecakeh]

Previously, titles would appear that do not link to a subschema definition. It would also mean that named subschemas would appear without being clearly referenced.

Now, the type clearly shows the nesting of objects and subschema definitions should be clearly referenced.

Examples:

Before:

After:

Before:

After:

Before:

After:

Alternatively, we could just remove the title from the objects manually, allowing us to show a title when we really want to.

The rendered types can be improved later by using formats as introduced in #1796.

Preview: https://pr1801--matrix-spec-previews.netlify.app

[richvdh]

Yes, I'd noticed this too. Suppressing the title when we aren't going to make a separate table sounds right to me.

[richvdh]

we should mention .properties in the comment for this partial.

[zecakeh]

Done

[richvdh]

I must say this logic makes my head explode, though I think it's probably right.

What if we did something like this instead:

{{ $title = or .title "object" }}
{{ if .anchor }}
    {{ $title = printf "<a href=\"#%s\">%s</a>" (htmlEscape .anchor) $type }}
{{ end }}

{{ if .properties }} 
    {{/*
        The object has its own (regular) properties, so we will make a separate table for it. 
        Refer to it using its title, if it has one.
    */}}
    {{ $type = $title }}
{{ else if reflect.IsMap .additionalProperties }}
    // as before
{{ else if reflect.IsMap .patternProperties }}
    // as before
{{ else }}
    {{/*
        No properties, so there won't be a separate table. We use the title anyway, because showing the title
        (like `EventFilter`) is better than showing `object`.
    */}}
    {{ $type = $title }}
{{ end }}

[zecakeh]

Yes, that's probably easier to read. I'll change it.

[zecakeh]

Changed

[richvdh]

Thanks!