Skip to content

RST scan #1035

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

Merged
merged 2 commits into from
Jan 15, 2025
Merged

RST scan #1035

merged 2 commits into from
Jan 15, 2025

Conversation

luszczewskakasia1
Copy link
Contributor

@luszczewskakasia1 luszczewskakasia1 commented Jan 13, 2025

Description

Add scan for RST files in case of some typos and spelling errors alongside with a list of words to exclude.

Checklist

  • Code compiles without errors locally
  • All tests pass locally
  • CI workflows execute properly
  • CI workflows, not executed per PR (e.g. Nightly), execute properly
  • New tests added, especially if they will fail without my changes
  • Added/extended example(s) to cover this functionality
  • Extended the README/documentation
  • All newly added source files have a license
  • All newly added source files are referenced in CMake files
  • Logger (with debug/info/... messages) is used

Fixes: #312
Fixes: #148

@luszczewskakasia1 luszczewskakasia1 requested a review from a team as a code owner January 13, 2025 15:04
customizable
deallocations
malloc
jemalloc
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this could be an occasion to clean up our docs a little and choose always use e.g. "Jemalloc" (starting with cap) vs "jemalloc" or "UMF" vs "umf" - what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

I vote for jemalloc (this is their original spelling in multiple places)

as for umf - I think it's showing up here, because we use e.g. include <umf/..; but normally I agree we should use UMF in the docs (as it's an abbreviation and should be uppercase)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Jemalloc removed, only jemalloc stayed

customizable
deallocations
malloc
jemalloc
Copy link
Contributor

Choose a reason for hiding this comment

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

I vote for jemalloc (this is their original spelling in multiple places)

as for umf - I think it's showing up here, because we use e.g. include <umf/..; but normally I agree we should use UMF in the docs (as it's an abbreviation and should be uppercase)

@luszczewskakasia1 luszczewskakasia1 force-pushed the rst-scan branch 4 times, most recently from 2d093e3 to 6cee0a1 Compare January 14, 2025 12:02
@luszczewskakasia1 luszczewskakasia1 marked this pull request as draft January 14, 2025 12:17
@luszczewskakasia1 luszczewskakasia1 marked this pull request as ready for review January 14, 2025 12:50
Copy link
Contributor

@lukaszstolarczuk lukaszstolarczuk left a comment

Choose a reason for hiding this comment

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

minor issues, in general it looks good

@luszczewskakasia1 luszczewskakasia1 force-pushed the rst-scan branch 2 times, most recently from 7c6dacc to a9d3d70 Compare January 14, 2025 14:26
@luszczewskakasia1 luszczewskakasia1 force-pushed the rst-scan branch 3 times, most recently from b2b3ad8 to 63eef2a Compare January 14, 2025 15:04
@lukaszstolarczuk lukaszstolarczuk merged commit c2781ff into oneapi-src:main Jan 15, 2025
78 checks passed
@luszczewskakasia1 luszczewskakasia1 deleted the rst-scan branch January 28, 2025 13:19
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.

Increase the CI spell checker efficiency Fix or disable warnings when building HTML documentation
4 participants