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

[AIRFLOW-XXX] Correct typos in UPDATING.md master #4242

Merged
merged 1 commit into from
Nov 27, 2018
Merged

[AIRFLOW-XXX] Correct typos in UPDATING.md master #4242

merged 1 commit into from
Nov 27, 2018

Conversation

dlamblin
Copy link
Contributor

Make sure you have checked all steps below.

Jira

  • My PR addresses fixing a typo in the documentation and so prepends commit with [AIRFLOW-XXX].

Description

Applies to master; pull request 4241 applies to `v1-10-stable.

  • Started with "habe", "serever" and "certificiate" needing to be:
    "have", "server", and "certificate".
  • Ran a check, ignoring British and US accepted spellings.
  • Kept jargon. EG admin, aync, auth, backend, config, dag, s3, utils, etc.
  • Took exception to:
    • "num of dag run" meaning "number of dag runs",
    • "upness" is normally for quarks,
    • "url" being lower-case, and
    • sftp example having an excess file ending.
  • Python documentation writes "builtin" hyphenated, cases "PYTHONPATH".
  • Gave up on mixed use of "dag" and "DAG" as well as long line lengths.

Tests

  • My PR does not need testing for this extremely good reason: It is scoped to documentation

Commits

  • My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

  • Updates only existing documentation.

Code Quality

  • Passes flake8

Started with "habe", "serever" and "certificiate" needing to be:
  "have", "server", and "certificate".
Ran a check, ignoring British and US accepted spellings.
Kept jargon. EG admin, aync, auth, backend, config, dag, s3, utils, etc.
Took exception to: "num of dag run" meaning "number of dag runs",
  "upness" is normally for quarks,
  "url" being lower-case, and
  sftp example having an excess file ending.
Python documentation writes "builtin" hyphenated, cases "PYTHONPATH".
Gave up on mixed use of "dag" and "DAG" as well as long line lengths.
@dlamblin
Copy link
Contributor Author

Not sure how you mange the diffs from the master and stable branch to this doc.
See also #4241

@feng-tao feng-tao merged commit f8027d4 into apache:master Nov 27, 2018
elizabethhalper pushed a commit to cse-airflow/incubator-airflow that referenced this pull request Dec 7, 2018
Started with "habe", "serever" and "certificiate" needing to be:
  "have", "server", and "certificate".
Ran a check, ignoring British and US accepted spellings.
Kept jargon. EG admin, aync, auth, backend, config, dag, s3, utils, etc.
Took exception to: "num of dag run" meaning "number of dag runs",
  "upness" is normally for quarks,
  "url" being lower-case, and
  sftp example having an excess file ending.
Python documentation writes "builtin" hyphenated, cases "PYTHONPATH".
Gave up on mixed use of "dag" and "DAG" as well as long line lengths.
aliceabe pushed a commit to aliceabe/incubator-airflow that referenced this pull request Jan 3, 2019
Started with "habe", "serever" and "certificiate" needing to be:
  "have", "server", and "certificate".
Ran a check, ignoring British and US accepted spellings.
Kept jargon. EG admin, aync, auth, backend, config, dag, s3, utils, etc.
Took exception to: "num of dag run" meaning "number of dag runs",
  "upness" is normally for quarks,
  "url" being lower-case, and
  sftp example having an excess file ending.
Python documentation writes "builtin" hyphenated, cases "PYTHONPATH".
Gave up on mixed use of "dag" and "DAG" as well as long line lengths.
wmorris75 pushed a commit to modmed/incubator-airflow that referenced this pull request Jul 29, 2019
Started with "habe", "serever" and "certificiate" needing to be:
  "have", "server", and "certificate".
Ran a check, ignoring British and US accepted spellings.
Kept jargon. EG admin, aync, auth, backend, config, dag, s3, utils, etc.
Took exception to: "num of dag run" meaning "number of dag runs",
  "upness" is normally for quarks,
  "url" being lower-case, and
  sftp example having an excess file ending.
Python documentation writes "builtin" hyphenated, cases "PYTHONPATH".
Gave up on mixed use of "dag" and "DAG" as well as long line lengths.
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