apache / apache/airflow

Apply dedent when docstring is passed as task doc

Open
#66,477 1 comment 0 reactions 0 assignees View on GitHub
area:UI kind:feature needs-triage
Dominant language
Python
Stars
46.9k
Forks
17.8k
Avg merge
2d 9h
Merged PRs (30d)
472

Description

### Description

When using task decorator, task documentation can be passed using via the function docstring like this

```python
@task(task_display_name="My task")
def my_task(**context):
"""
This task do ...

In case of error you should do ...
"""
```

Unfortuntally, since no dedent is applied the display in the user interface is unattractive. It's possible to achieve a good result by removing the indentation from the DAG file, but this makes the code less readable.

### Use case/motivation

_No response_

### Related issues

_No response_

### Are you willing to submit a PR?

- [ ] Yes I am willing to submit a PR!

### Code of Conduct

- [x] I agree to follow this project's [Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.