You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "rbb17 (via GitHub)" <gi...@apache.org> on 2023/03/07 10:58:50 UTC
[GitHub] [airflow] rbb17 opened a new pull request, #29951: [AIRFLOW-26364] Fixing missing whitespaces issue in airflow docs
rbb17 opened a new pull request, #29951:
URL: https://github.com/apache/airflow/pull/29951
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
closes: [#ISSUE-26364](https://github.com/apache/airflow/issues/26364)
Issue-
The source of the error is in regex pattern provided for removing tags in removemarktransform.py file. Pattern provided was considering all the blank lines before the tag, and later in the code we were subtracting it. Hence blank lines were not present in the airflow docs.
Solution-
Fixed the regex pattern
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] rbb17 commented on a diff in pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "rbb17 (via GitHub)" <gi...@apache.org>.
rbb17 commented on code in PR #29951:
URL: https://github.com/apache/airflow/pull/29951#discussion_r1130528256
##########
airflow/example_dags/tutorial_taskflow_api.py:
##########
@@ -45,8 +43,8 @@ def tutorial_taskflow_api():
located
[here](https://airflow.apache.org/docs/apache-airflow/stable/tutorial_taskflow_api.html)
"""
- # [END instantiate_dag]
+ # [END instantiate_dag]
Review Comment:
Yes, added it to maintain a gap between the comment and the function. can revert it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1536927316
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on a diff in pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on code in PR #29951:
URL: https://github.com/apache/airflow/pull/29951#discussion_r1130487739
##########
docs/exts/removemarktransform.py:
##########
@@ -44,7 +44,7 @@ def apply(self, **kwargs):
for node in self.document.traverse(nodes.literal_block):
if self.is_pycode(node):
source = node.rawsource
- source = docmark_re.sub("", source)
+ source = docmark_re.sub(r"", source)
Review Comment:
Why the `r`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] rbb17 commented on a diff in pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "rbb17 (via GitHub)" <gi...@apache.org>.
rbb17 commented on code in PR #29951:
URL: https://github.com/apache/airflow/pull/29951#discussion_r1130523534
##########
airflow/example_dags/tutorial_taskflow_api.py:
##########
@@ -45,8 +43,8 @@ def tutorial_taskflow_api():
located
[here](https://airflow.apache.org/docs/apache-airflow/stable/tutorial_taskflow_api.html)
"""
- # [END instantiate_dag]
+ # [END instantiate_dag]
Review Comment:
No, removed blank lines between 2 tags, purely cosmetical change can revert.
##########
airflow/example_dags/tutorial_taskflow_api.py:
##########
@@ -45,8 +43,8 @@ def tutorial_taskflow_api():
located
[here](https://airflow.apache.org/docs/apache-airflow/stable/tutorial_taskflow_api.html)
"""
- # [END instantiate_dag]
+ # [END instantiate_dag]
Review Comment:
No, removed blank lines between 2 tags, purely cosmetical change, can revert.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1459006008
The result of this change looks awful. Too much of a white space. Can you please also fix all the affected examples so that they render to something much more reasonable?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] rbb17 commented on pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "rbb17 (via GitHub)" <gi...@apache.org>.
rbb17 commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1465286131
> update images looks good but I wonder if we have a way to verify how other docs looks? I'm worried that in other places it might look bad and require further manual fixes?
Have to do manually only, I guess. I cant see any other way around.
Should I do it manually only or can you suggest a way around?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] closed pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #29951: Fixing missing whitespaces in airflow docs
URL: https://github.com/apache/airflow/pull/29951
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] boring-cyborg[bot] commented on pull request #29951: [AIRFLOW-26364] Fixing missing whitespaces issue in airflow docs
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1457966323
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (ruff, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/BREEZE.rst) for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#coding-style-and-best-practices).
Apache Airflow is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] rbb17 commented on pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "rbb17 (via GitHub)" <gi...@apache.org>.
rbb17 commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1460692482
Fixed affected examples.
Updated regex pattern a bit, and removed redundant blank lines from example_dags.
Now-
<img width="1552" alt="Screenshot 2023-03-08 at 8 05 57 PM" src="https://user-images.githubusercontent.com/112069583/223804689-2d2e73f2-1e8a-4f61-98b4-d986c06e923f.png">
<img width="1552" alt="Screenshot 2023-03-08 at 8 06 03 PM" src="https://user-images.githubusercontent.com/112069583/223804733-9ae53249-7a52-49c3-8f31-ba05e352806e.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] rbb17 commented on a diff in pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "rbb17 (via GitHub)" <gi...@apache.org>.
rbb17 commented on code in PR #29951:
URL: https://github.com/apache/airflow/pull/29951#discussion_r1130518713
##########
docs/exts/removemarktransform.py:
##########
@@ -44,7 +44,7 @@ def apply(self, **kwargs):
for node in self.document.traverse(nodes.literal_block):
if self.is_pycode(node):
source = node.rawsource
- source = docmark_re.sub("", source)
+ source = docmark_re.sub(r"", source)
Review Comment:
Removed the r, in the next commit. Was a syntax error.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] github-actions[bot] commented on pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1647003726
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] eladkal commented on pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "eladkal (via GitHub)" <gi...@apache.org>.
eladkal commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1465188701
update images looks good but I wonder if we have a way to verify how other docs looks?
I'm worried that in other places it might look bad and require further manual fixes?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1468962200
> > update images looks good but I wonder if we have a way to verify how other docs looks? I'm worried that in other places it might look bad and require further manual fixes?
>
> Have to do manually only, I guess. I cant see any other way around. Should I do it manually only or can you suggest a way around?
I guess manual is best, you could speed it up by finding patterns that lead to awful view and automate some parts of it likely
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] potiuk commented on pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1478549957
Hmmm. Are you sure these are all? we have likely multiple 100s of examples accross our documentation (including all examples in provider packages (https://airflow.apache.org/docs/). Have you checked those?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on a diff in pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on code in PR #29951:
URL: https://github.com/apache/airflow/pull/29951#discussion_r1130525864
##########
airflow/example_dags/tutorial_taskflow_api.py:
##########
@@ -45,8 +43,8 @@ def tutorial_taskflow_api():
located
[here](https://airflow.apache.org/docs/apache-airflow/stable/tutorial_taskflow_api.html)
"""
- # [END instantiate_dag]
+ # [END instantiate_dag]
Review Comment:
But you also added a blank line before the END tag.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] uranusjr commented on a diff in pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on code in PR #29951:
URL: https://github.com/apache/airflow/pull/29951#discussion_r1130487463
##########
airflow/example_dags/tutorial_taskflow_api.py:
##########
@@ -45,8 +43,8 @@ def tutorial_taskflow_api():
located
[here](https://airflow.apache.org/docs/apache-airflow/stable/tutorial_taskflow_api.html)
"""
- # [END instantiate_dag]
+ # [END instantiate_dag]
Review Comment:
Is this accidental?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] rbb17 commented on pull request #29951: Fixing missing whitespaces in airflow docs
Posted by "rbb17 (via GitHub)" <gi...@apache.org>.
rbb17 commented on PR #29951:
URL: https://github.com/apache/airflow/pull/29951#issuecomment-1542530236
> Hmmm. Are you sure these are all? we have likely multiple 100s of examples accross our documentation (including all examples in provider packages (https://airflow.apache.org/docs/). Have you checked those?
I guess I covered all such examples, were such patterns were present. Will cross-verify again.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org