Skip to content

Spelling#331

Merged
AllanJard merged 61 commits intoDataTables:masterfrom
jsoref:spelling
Aug 13, 2025
Merged

Spelling#331
AllanJard merged 61 commits intoDataTables:masterfrom
jsoref:spelling

Conversation

@jsoref
Copy link
Copy Markdown
Contributor

@jsoref jsoref commented Mar 20, 2025

No description provided.

Comment thread build/lib/markdown.php Outdated
Comment thread build/lib/markdown.php Outdated
Comment thread docs/api/any().xml
<signature>any()</signature>
<description>Get a boolean value to indicate if there are any entries in the API instance's result set (i.e. any data, selected rows, etc).</description>
<returns type="boolean">`true` if there there is one or more items in the result set, `false` otherwise.</returns>
<returns type="boolean">`true` if there are one or more items in the result set, `false` otherwise.</returns>
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

atypical correction...

* `string` - As a string, a single child row is create and the data is inserted into a single cell in that child row.
* `node` - As a `dt-tag tr` element, the `dt-tag tr` element is used as the child row. This can be useful it you wish to define multiple columns in the child row.
* `jQuery` - A jQuery object with nodes to be added. If there are multiple elements in the jQuery result set, they are added as multiple rows. If the node is `dt-tag tr` element it is treated a the child row, otherwise a row and cell are automatically created and the node from the jQuery result set inserted into it.
* `jQuery` - A jQuery object with nodes to be added. If there are multiple elements in the jQuery result set, they are added as multiple rows. If the node is `dt-tag tr` element it is treated as the child row, otherwise a row and cell are automatically created and the node from the jQuery result set inserted into it.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Atypical correction, the rule is against a+the (generally I don't check 1-2 letter words)

Comment thread js/core/core.draw.js
* Use the DOM source to create up an array of header cells. The idea here is to
* create a layout grid (array) of rows x columns, which contains a reference
* to the cell that that point in the grid (regardless of col/rowspan), such that
* to the cell at that point in the grid (regardless of col/rowspan), such that
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

atypical correction

Comment thread js/ext/ext.renderer.js
// listening for
$(settings.nTable).on( 'order.dt.DT column-visibility.dt.DT', function ( e, ctx ) {
if ( settings !== ctx ) { // need to check this this is the host
if ( settings !== ctx ) { // need to check if this is the host
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

atypical

Comment thread docs/option/stateLoadCallback.xml Outdated
Comment thread build/lib/markdown.php Outdated
Comment thread build/lib/markdown.php Outdated
jsoref added 3 commits August 12, 2025 11:54
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Copy link
Copy Markdown
Contributor

@AllanJard AllanJard left a comment

Choose a reason for hiding this comment

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

This should be diacritic rather than the original or the proposed replacement.

Comment thread docs/option/columns.type.xml Outdated
jsoref added 23 commits August 12, 2025 11:57
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
jsoref added 22 commits August 12, 2025 11:58
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
@jsoref
Copy link
Copy Markdown
Contributor Author

jsoref commented Aug 12, 2025

Thanks @AllanJard. Updated.

@AllanJard
Copy link
Copy Markdown
Contributor

This is an amazing PR - thank you for helping to improve the documentation and I'm sorry it has taken me so long to review it.

I've looked though them all now and I think it is just that struc / struct one. I'll double check once that change is made, if you are happy to make that please.

Have you got some custom software you are using for this sort of spelling review? There are a number of changes there that aren't just simple search and replace...

@jsoref
Copy link
Copy Markdown
Contributor Author

jsoref commented Aug 12, 2025

❤️

I don't see a review comment about struc/struct...

I imagine you're asking about 139f586

function _api_scope( scope, fn, struct ) {
return function () {
var ret = fn.apply( scope || this, arguments );
// Method extension
_Api.extend( ret, ret, struct.methodExt );

Note that this file already had instances of struct:

_Api.extend = function ( scope, obj, ext )
{
// Only extend API instances and static properties of the API
if ( ! ext.length || ! obj || ( ! (obj instanceof _Api) && ! obj.__dt_wrapper ) ) {
return;
}
var
i, iLen,
struct;
for ( i=0, iLen=ext.length ; i<iLen ; i++ ) {
struct = ext[i];
if (struct.name === '__proto__') {
continue;
}
// Value
obj[ struct.name ] = struct.type === 'function' ?
_api_scope( scope, struct.val, struct ) :


Have you got some custom software you are using for this sort of spelling review? There are a number of changes there that aren't just simple search and replace...

For the review, yes, the tooling is basically:
https://www.check-spelling.dev/
I tend to use the prerelease version of the software along w/ an ever growning set of heuristics:
https://github.com/check-spelling/spell-check-this/tree/prerelease/.github/actions/spelling

Corrections are all manual, although I do have some extra tooling for search+replacing.

I iterate through the fix process

Other projects use the software, and I'm happy to help if you're interested in using it.

@AllanJard AllanJard merged commit 57b777c into DataTables:master Aug 13, 2025
@AllanJard
Copy link
Copy Markdown
Contributor

Its really impressive - thank you! It's great to have these fixed en mass and to improve the quality of the documentation! I will look at using the bot on my repos :)

@jsoref jsoref deleted the spelling branch August 13, 2025 11:27
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