Remove heading tags in html table

[simonkeys]

Description

The html fit reports contain h2 tags, which are interpreted as section headings by the table of contents sidebar of JupyterLab. I'm assuming that's undesirable behavior for everyone, so I just replaced the h2 tags with b.

If there is a specific reason for the h2 tags, I could instead add function parameters to specify which tag is desired.

Type of Changes

• Bug fix
• New feature
• Refactoring / maintenance
• Documentation / examples

Tested on

Python: 3.8.15 | packaged by conda-forge | (default, Nov 22 2022, 08:53:40)
[Clang 14.0.6 ]
lmfit: 1.2.1.post1+ga246cbc7, scipy: 1.9.3, numpy: 1.23.5, asteval: 0.9.28, uncertainties: 3.1.7

Verification

Have you

• included docstrings that follow PEP 257?

• referenced existing Issue and/or provided relevant link to mailing list?

• verified that existing tests pass locally?

• verified that the documentation builds locally?

• squashed/minimized your commits and written descriptive commit messages?

• added or updated existing tests to cover the changes?
• updated the documentation and/or added an entry to the release notes (doc/whatsnew.rst)?
• added an example?

[newville]

@simonkeys I'm afraid that it is not obvious to me why using h2 is undesirable. If the HTML contents of Jupyter cells cannot have headings, that seems like a Jupyter error to me.

Anyway, <b> is a text-formatting directive, whereas <hN> gives a semantic directive. They are not really interchangeable. Perhaps using <h3> or <h4> would be better?

Being able to reference a Discussion or clearly identified Issue is greatly preferred for PRs.

[reneeotten]

I have never used Jupyterlab and friends - in fact, I just tried it to see what the HTML report would look like and cannot get it to do anything so I have no idea ;)

Anyway, the original proposal for this code was by @Tillsten so I assume that he is using it and therefore perhaps can comment on the reported issue and proposed solution?

[newville]

@reneeotten @simonkeys @Tillsten I think we need a demonstration of a problem before we can assess any proposed solutions. Please create a discussion on this topic.

[simonkeys]

I have started a discussion (#884). Apologies for skipping this step earlier.

[newville]

@simonkeys @reneeotten Any thoughts on getting this to a point of completion?

[newville]

superseded by #902