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

Docs: Edit 12.4.0 docs #10374

Merged
merged 12 commits into from
May 22, 2023
Merged

Docs: Edit 12.4.0 docs #10374

merged 12 commits into from
May 22, 2023

Conversation

kirszenbaum
Copy link
Contributor

@kirszenbaum kirszenbaum commented May 16, 2023

This PR:

  • Edits the 12.4.0 changelog entries
  • Adds 12.4.0 release notes
  • Updates the docs' CodeSandbox demos to forked ones with updated HoT dependencies
  • In the Bare distribution section of the Packages page, updates the dompurify version to 2.4.5
  • Updates links in the Find the code on GitHub section
  • Applies further changes listed below

New hooks: afterColumnSequenceChange and afterRowSequenceChange

  • Fixed the API refs of the newly-added hooks (they didn't show up in the docs)
  • Rewrote the hooks' API descriptions

Formula calculation page

[skip changelog]

@kirszenbaum kirszenbaum self-assigned this May 16, 2023
@kirszenbaum kirszenbaum added the Docs: Content Issues related to Handsontable's documentation content label May 16, 2023
@github-actions
Copy link

github-actions bot commented May 16, 2023

Launch the local version of documentation by running:

npm run docs:review 4d2c61fe328c95fd38f68c0a6cbe79fcfad82ec4

*
* @param {'init'|'remove'|'insert'|'move'|'update'} [source] String that identifies source of row sequence change.
Copy link
Member

Choose a reason for hiding this comment

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

@kirszenbaum
Is there a reason why you changed the @param type from a list of possible values to {string}?
I can't find it in the JSDoc documentation, but I think it's a valid syntax 🤔

Copy link
Contributor Author

@kirszenbaum kirszenbaum May 19, 2023

Choose a reason for hiding this comment

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

@jansiegel it works, but it renders, for example, like this (source > output):

2

I guess we should keep the syntax and create an issue for rendering it properly?

Copy link
Member

Choose a reason for hiding this comment

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

@kirszenbaum I'd think so, @wszymanski WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

We don't have lot of places typed in JSDoc in that way, but they exist. For example, we can see how it look like for DataMap's method: https://handsontable.com/docs/javascript-data-grid/api/data-map/#createrow. Probably the docs engine should be changed, not the documentation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

I just run the new docs and the issue still looks the same for the createRow as long as for the new hooks. @kirszenbaum were those changes merged? (It seems that they should be merged with the 12.4.0 docs)

Zrzut ekranu 2023-05-23 o 13 34 29

Zrzut ekranu 2023-05-23 o 13 34 14

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@AMBudnik – that's the expected outcome (as discussed here). The JSDocs syntax is correct but we need to fix the way it's rendered in the docs. I'll create an issue for that.

@kirszenbaum kirszenbaum merged commit 1e3a960 into release/12.4.0 May 22, 2023
19 checks passed
@kirszenbaum kirszenbaum deleted the docs/12.4.0 branch May 22, 2023 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs: Content Issues related to Handsontable's documentation content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants