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

DX: add spelling checker and improve texts #28

Merged
merged 10 commits into from
May 28, 2024

Conversation

redeboer
Copy link
Collaborator

  • Enforced cSpell as spelling checker through pre-commit and vscode.
  • Fixed typos.
  • Reformulated some of the paragraphs.

@redeboer redeboer added the 📝 Docs Improvements or additions to documentation label May 13, 2024
@redeboer redeboer requested a review from mmikhasenko May 13, 2024 08:22
@redeboer
Copy link
Collaborator Author

This PR is meant to further clarify some of the pages, while implementing a serializer for ampform-dpd. Will post comments here if things are unclear to me and we can improve the format description if needed.

docs/description.md Outdated Show resolved Hide resolved
docs/description.md Outdated Show resolved Hide resolved
docs/description.md Outdated Show resolved Hide resolved
docs/description.md Outdated Show resolved Hide resolved
@redeboer redeboer mentioned this pull request May 14, 2024
@mmikhasenko mmikhasenko marked this pull request as ready for review May 27, 2024 20:34
Copy link
Collaborator

@mmikhasenko mmikhasenko left a comment

Choose a reason for hiding this comment

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

read thought test and comment, minor rephrasing

@mmikhasenko
Copy link
Collaborator

#48 is duplicating this PR

@redeboer redeboer changed the title DOC: improve texts and check spelling DX: add spelling checker and improve texts May 28, 2024
@redeboer redeboer enabled auto-merge (squash) May 28, 2024 09:11
@redeboer redeboer merged commit 1230a12 into RUB-EP1:main May 28, 2024
3 checks passed
@redeboer redeboer deleted the update-description branch May 28, 2024 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants