Skip to content

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 v1-10-stable; another pull will apply to master.

  • 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.
Copy link
Member

@feng-tao feng-tao left a comment

Choose a reason for hiding this comment

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

thanks. lgtm

@dlamblin
Copy link
Contributor Author

Welcome; not sure how you mange the diffs from the master and stable branch to this doc.
See also #4242

@feng-tao
Copy link
Member

just found out that you are updating the v10 branch. cc @ashb , I am not sure if we still update the release branch though.

@dlamblin
Copy link
Contributor Author

I saw on the JIRA it's possible to mark fixed in 1.10.2, so that's why I make this pull request.
You merged 4242, but I wasn't sure if someone would manually reapply that edit into the v1-10-stable branch.

That test_get_conn (tests.contrib.hooks.test_redis_hook.TestRedisHook) ... FAILED is pretty consistent for this PR. Is that some known flakey test?

@feng-tao
Copy link
Member

thanks @dlamblin , I don't think we need to worry about that unit test fails for this pr given it just changes the doc.

@kaxil kaxil merged this pull request into apache:v1-10-stable Nov 27, 2018
@feng-tao
Copy link
Member

@kaxil , so this won't go into pypi unless we manually push so, right? So what is the purpose of merging this change into both master branch and v10 branch? And have we had consensus on whether we are going to maintain/ update all the release branch? And what pr should go to both release branch and master branch?

@kaxil
Copy link
Member

kaxil commented Nov 27, 2018

@feng-tao You are right, I had merged it in the morning and didn't release it pointed to 1.10 branch and then dropped that commit as I saw it went to 1.10 branch :)

We would not want anything to change our stable branches.

@feng-tao
Copy link
Member

thanks @kaxil

@ashb
Copy link
Member

ashb commented Nov 27, 2018

And yes, PyPI releases are entirely a manual process.

@Fokko
Copy link
Contributor

Fokko commented Dec 2, 2018

Thanks @dlamblin

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.

5 participants