Skip to content

Commit

Permalink
[docs] update DagBag class docstring to include all params (#38814)
Browse files Browse the repository at this point in the history
* update docstring for DagBag class

* break long line

* fix space

Signed-off-by: kalyanr <[email protected]>

---------

Signed-off-by: kalyanr <[email protected]>
(cherry picked from commit b002741)
  • Loading branch information
rawwar authored and jedcunningham committed Apr 26, 2024
1 parent 2970e35 commit 672d47e
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions airflow/models/dagbag.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,16 @@ class DagBag(LoggingMixin):
:param dag_folder: the folder to scan to find DAGs
:param include_examples: whether to include the examples that ship
with airflow or not
:param safe_mode: when ``False``, scans all python modules for dags.
When ``True`` uses heuristics (files containing ``DAG`` and ``airflow`` strings)
to filter python modules to scan for dags.
:param read_dags_from_db: Read DAGs from DB if ``True`` is passed.
If ``False`` DAGs are read from python files.
:param store_serialized_dags: deprecated parameter, same effect as `read_dags_from_db`
:param load_op_links: Should the extra operator link be loaded via plugins when
de-serializing the DAG? This flag is set to False in Scheduler so that Extra Operator links
are not loaded to not run User code in Scheduler.
:param collect_dags: when True, collects dags during class initialization.
"""

def __init__(
Expand Down

0 comments on commit 672d47e

Please sign in to comment.