-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Docs: Edit 12.4.0 docs #10374
Conversation
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. |
There was a problem hiding this comment.
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 🤔
There was a problem hiding this comment.
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](https://private-user-images.githubusercontent.com/29247866/239482486-13dd5e10-8c3f-4cc1-a9fd-37ba905363be.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjAzMTYxMzEsIm5iZiI6MTcyMDMxNTgzMSwicGF0aCI6Ii8yOTI0Nzg2Ni8yMzk0ODI0ODYtMTNkZDVlMTAtOGMzZi00Y2MxLWE5ZmQtMzdiYTkwNTM2M2JlLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MDclMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzA3VDAxMzAzMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdkMGI5OGI3ZDg3ZWNkOGU3NTU5MWQ2NzQwZDk1ZGJiOGI1ZGQzMjM3Nzg1MTk4YjY3ZTZkYzM0MWQ5NGZkNWUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.AdcZAoPhW2IcvfFr5sOjqMoSuMnRFhIhD4nTSvqj_QM)
I guess we should keep the syntax and create an issue for rendering it properly?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jansiegel @wszymanski ok, done: 3a2f19a
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR:
dompurify
version to2.4.5
New hooks:
afterColumnSequenceChange
andafterRowSequenceChange
Formula calculation page
IndexMapper
into a new Known limitations sectionafterColumnSequenceChange
andafterRowSequenceChange
hooks and synchronization of actions done on HOT with HF's engine #10215)[skip changelog]