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

(CM) Some typos corrected in hello-elektra tutorial #2481

Open
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
3 participants
@nastiaulian
Copy link

nastiaulian commented Mar 11, 2019

Basics

Do not describe the purpose here but:

  • Short descriptions should be in the release notes (added as entry in
    doc/news/_preparation_next_release.md which contains _(my name)_)
    Please always add something to the the release notes.
  • Longer descriptions should be in documentation or in design decisions.
  • Describe details of how you changed the code in commit messages
    (first line should have module: short statement syntax)
  • References to issues, e.g. close #X, should be in the commit messages.

Checklist

Check relevant points but please do not remove entries.
For docu fixes, spell checking, and similar none of these points below
need to be checked.

  • I added unit tests
  • I ran all tests locally and everything went fine
  • affected documentation is fixed
  • I added code comments, logging, and assertions (see doc/CODING.md)
  • meta data is updated (e.g. README.md of plugins)

Review

Remove the line below and add the "work in progress" label if you do
not want the PR to be reviewed:

@markus2330 please review my pull request

Anastasia added some commits Mar 11, 2019

@markus2330

This comment has been minimized.

Copy link
Contributor

markus2330 commented Mar 11, 2019

Thank you for creating the PR! I invited you to the cm2019s group.

@markus2330

This comment has been minimized.

Copy link
Contributor

markus2330 commented Mar 13, 2019

@nastiaulian did you find places where this dots were not done?

I think @sanssecours likes to always end sentences with dots, even if the sentence spreads across code snippets.

@sanssecours

This comment has been minimized.

Copy link
Member

sanssecours commented Mar 13, 2019

I think @sanssecours likes to always end sentences with dots, even if the sentence spreads across code snippets.

Yep, that is correct. I think I started using this style, after I read a guideline that required a dot after each sentence.

@nastiaulian 👋 If you want to find spelling mistakes in the documentation the command line tool markdown-spellcheck might be worth a try.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.