Question related to docs

What’s up with this “:” beneath every “Example using” section?

It’s just the method name taking up the whole line, so the colon gets pushed to a new line. You can just read it as:

Examples using append:

Should be seen as a UI bug or not? I think, it looks weird indeed.

I agree it looks a bit strange, but I wouldn’t say it’s a bug, just a quirk in how the examples section gets rendered: mne-python/doc/conf.py at 01b5bd430c57053160cd936e77a9916b3a6e06fc · mne-tools/mne-python · GitHub

What would your thoughts be on trying to have the section header render as a single line @drammock, @larsoner, and others?

Yes it would be much better if it fit in a singe line. Looks like this is due to the rubric getting a flex display with direction: column

If we change it to row it goes to a single line, but still looks kind of bad

In any case yes tweaking our CSS or our appending code to make this render properly would be a welcome PR!

1 Like

… easiest would be in our code just to remove the double-backticks, it should look fine anyway and get the point across: .. rubric:: Examples using {0}


An added margin looks good too?

1 Like

Yeah, I’d say a gap before the method name looks nicer.
Feel free to open a PR, either changing the CSS or backticks as mentioned above!