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

punctual typo fixes and corrections in docs #478

Merged
merged 1 commit into from
Dec 5, 2024
Merged

Conversation

lukaspie
Copy link
Collaborator

@lukaspie lukaspie commented Dec 5, 2024

No description provided.

@lukaspie lukaspie requested a review from mkuehbach December 5, 2024 09:00
@rettigl
Copy link
Collaborator

rettigl commented Dec 5, 2024

Generally, I found it useful to have a spell-checker as part of the pre-commit hooks and linting workflows. For an example see e.g. here: https://github.com/rettigl/pynxtools-igor/blob/bb40b318722c22b5e52ac9440ab0b6ea14a7cf59/.github/workflows/pylint.yml#L32

Copy link
Collaborator

@sanbrock sanbrock left a comment

Choose a reason for hiding this comment

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

LGTM

@sanbrock sanbrock merged commit 2ab4674 into master Dec 5, 2024
16 checks passed
@lukaspie lukaspie deleted the typo-and-url-fixes branch December 5, 2024 10:57
@lukaspie
Copy link
Collaborator Author

lukaspie commented Dec 5, 2024

Generally, I found it useful to have a spell-checker as part of the pre-commit hooks and linting workflows. For an example see e.g. here: https://github.com/rettigl/pynxtools-igor/blob/bb40b318722c22b5e52ac9440ab0b6ea14a7cf59/.github/workflows/pylint.yml#L32

Yeah, that would probably make sense in the docs deployment. However, that doesn't help if somebody writes "FAIRMat" vs. "FAIRmat" (unless we explicitly define it). Anyway, I made an issue for this: #479

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.

3 participants