[
https://issues.apache.org/jira/browse/AIRFLOW-3996?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16789052#comment-16789052
]
ASF GitHub Bot commented on AIRFLOW-3996:
-----------------------------------------
mik-laj commented on pull request #4894: [AIRFLOW-3996] Add view source link to
include fragments
URL: https://github.com/apache/airflow/pull/4894
Make sure you have checked _all_ steps below.
### Jira
- [ ] My PR addresses the following [Airflow
Jira](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references
them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
- https://issues.apache.org/jira/browse/AIRFLOW-3996
- In case you are fixing a typo in the documentation you can prepend your
commit with \[AIRFLOW-XXX\], code changes always need a Jira issue.
- In case you are proposing a fundamental code change, you need to create
an Airflow Improvement
Proposal([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)).
### Description
I added buttons that will allow you to go to the source code of the whole
file with an example.
Preview: http://bloody-boundary.surge.sh/howto/operator/bash.html
UI component has been adapted to mobile devices.
We've discussed the different look of the header internally. It did not
include a button but a clickable filename. A vote took place and this is a
winning proposition.
Currently, it does not work for some examples for GCP operators due to
errors in their implementation. My team is planning to improve these operators
in the future. I also plan that other examples should also contain the full
source code and be tested automatically -
https://github.com/PolideaInternal/airflow/pull/77
### Tests
- [ ] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
### 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](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Documentation
- [ ] In case of new functionality, my PR adds documentation that describes
how to use it.
- When adding new operators/hooks/sensors, the autoclass documentation
generation needs to be added.
- All the public functions and the classes in the PR contain docstrings
that explain what it does
- If you implement backwards incompatible changes, please leave a note in
the [Updating.md](https://github.com/apache/airflow/blob/master/UPDATING.md) so
we can assign it to a appropriate release
### Code Quality
- [ ] Passes `flake8`
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
> Include full source code examples in the documentation
> ------------------------------------------------------
>
> Key: AIRFLOW-3996
> URL: https://issues.apache.org/jira/browse/AIRFLOW-3996
> Project: Apache Airflow
> Issue Type: Improvement
> Reporter: Kamil Bregula
> Priority: Major
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
