You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2020/05/14 22:32:20 UTC

[GitHub] [airflow] ashb opened a new pull request #8873: Fix list formatting of plugins doc.

ashb opened a new pull request #8873:
URL: https://github.com/apache/airflow/pull/8873


   This was causing it to be picked up as a `<dl>/<dd>` containing a list,
   instead of a paragraph and a list.
   
   ```
   <dl class="simple">
     <dt>This will create a hook, and an operator accessible at:</dt>
     <dd>
       <ul class="simple">
         <li><p><code><span class="pre">airflow.hooks.my_namespace.MyHook</span></code></p></li>
         <li><p><code><span class="pre">airflow.operators.my_namespace.MyOperator</span></code></p></li>
       </ul>
     </dd>
   </dl>
   ```
   
   I have tested this locally and looked at the html produced -- this fixes the problem (I can't include screenshot as it doesn't look noticably different as I don't have the theme installed.
   
   ---
   Make sure to mark the boxes below before creating PR: [x]
   
   - [x] Description above provides context of the change
   - [x] Unit tests coverage for changes (not needed for documentation changes)
   - [x] Target Github ISSUE in description if exists
   - [x] Commits follow "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)"
   - [x] Relevant documentation is updated including usage instructions.
   - [x] I will engage committers as explained in [Contribution Workflow Example](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#contribution-workflow-example).
   
   ---
   In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+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 [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
   Read the [Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines) for more information.


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [airflow] feluelle merged pull request #8873: Fix list formatting of plugins doc.

Posted by GitBox <gi...@apache.org>.
feluelle merged pull request #8873:
URL: https://github.com/apache/airflow/pull/8873


   


----------------------------------------------------------------
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:
users@infra.apache.org



[GitHub] [airflow] ashb commented on pull request #8873: Fix list formatting of plugins doc.

Posted by GitBox <gi...@apache.org>.
ashb commented on pull request #8873:
URL: https://github.com/apache/airflow/pull/8873#issuecomment-628920686


   For reference this is what it looks like in our published docs:
   
   ![image](https://user-images.githubusercontent.com/34150/81992446-5ca86c80-963b-11ea-8948-c219ab723924.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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org