Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation cleanup #1135

Merged
merged 15 commits into from
Oct 10, 2024
Merged

Documentation cleanup #1135

merged 15 commits into from
Oct 10, 2024

Conversation

zorkow
Copy link
Member

@zorkow zorkow commented Sep 30, 2024

This cleans up the majority of the jsdoc documentation.

There are still a few jsdoc linter warnings, that have to do with

  • missing returns type. These are sometimes too awkward to include, when they are major template types. We should have a think about them.
  • some of the parser methods not always returning a result. These needs to be corrected, with accompanying tests.

Also removes unused .eslintrc file and minimizes rule customization.

Copy link
Member

@dpvc dpvc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. Thanks for doing all the work on this. I have made a few minor comments and suggestions, but otherwise, ready to go.

ts/input/tex/textmacros/TextMacrosConfiguration.ts Outdated Show resolved Hide resolved
ts/input/tex/textmacros/TextMacrosConfiguration.ts Outdated Show resolved Hide resolved
ts/output/chtml/DynamicFonts.ts Show resolved Hide resolved
ts/output/common.ts Outdated Show resolved Hide resolved
ts/output/common.ts Outdated Show resolved Hide resolved
*/
protected filterAttribute(_name: string, value: string) {
protected filterAttribute(_name: string, value: string): string {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this function and filterClassList() below are never actually used. They were meant for the Safe extension to override, but that is done in a different way now, so they are really superfluous, and probably should be removed (together with the calls in this file that go to them).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought they are overwritten in ui/safe extension.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lines here and following:

if (jax.name.match(/MathML/)) {

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. I thought I had searched for them, but mist have done it incorrectly. Thanks for finding them.

ts/output/common/Notation.ts Outdated Show resolved Hide resolved
ts/output/common/Wrappers/TeXAtom.ts Outdated Show resolved Hide resolved
ts/output/common/Wrappers/XmlNode.ts Outdated Show resolved Hide resolved
ts/ui/menu/Menu.ts Outdated Show resolved Hide resolved
@dpvc dpvc added this to the v4.0 milestone Oct 6, 2024
Base automatically changed from refactor/slashes_in_regexp to develop October 10, 2024 12:55
@zorkow
Copy link
Member Author

zorkow commented Oct 10, 2024

Took care of all your points, with the exception of filterAttribute and filterClassList. If they can be removed we can do it in a separate PR.

@zorkow zorkow merged commit 117d0e8 into develop Oct 10, 2024
@zorkow zorkow deleted the refactor/more_jsdoc branch October 10, 2024 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants