Skip to content

Commit

Permalink
Fixing warnings with make docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kvnkho committed Jan 13, 2021
1 parent 81856e9 commit d9d125a
Show file tree
Hide file tree
Showing 7 changed files with 78 additions and 6 deletions.
8 changes: 8 additions & 0 deletions docs/api/fugue.collections.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,11 @@ fugue.collections.partition
:undoc-members:
:show-inheritance:

fugue.collections.yielded
-------------------------

.. automodule:: fugue.collections.yielded
:members:
:undoc-members:
:show-inheritance:

8 changes: 8 additions & 0 deletions docs/api/fugue.extensions.transformer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ fugue.extensions.transformer



fugue.extensions.transformer.constants
--------------------------------------

.. automodule:: fugue.extensions.transformer.constants
:members:
:undoc-members:
:show-inheritance:

fugue.extensions.transformer.convert
------------------------------------

Expand Down
46 changes: 46 additions & 0 deletions docs/api/fugue.rpc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
fugue.rpc
==========

.. |SchemaLikeObject| replace:: :ref:`Schema like object <tutorial:/tutorials/x-like.ipynb#schema>`
.. |ParamsLikeObject| replace:: :ref:`Parameters like object <tutorial:/tutorials/x-like.ipynb#parameters>`
.. |DataFrameLikeObject| replace:: :ref:`DataFrame like object <tutorial:/tutorials/x-like.ipynb#dataframe>`
.. |DataFramesLikeObject| replace:: :ref:`DataFrames like object <tutorial:/tutorials/x-like.ipynb#dataframes>`
.. |PartitionLikeObject| replace:: :ref:`Partition like object <tutorial:/tutorials/x-like.ipynb#partition>`

.. |ExecutionEngine| replace:: :class:`~fugue.execution.execution_engine.ExecutionEngine`
.. |NativeExecutionEngine| replace:: :class:`~fugue.execution.native_execution_engine.NativeExecutionEngine`
.. |FugueWorkflow| replace:: :class:`~fugue.workflow.workflow.FugueWorkflow`

.. |ReadJoin| replace:: Read Join tutorials on :ref:`workflow <tutorial:/tutorials/dag.ipynb#join>` and :ref:`engine <tutorial:/tutorials/execution_engine.ipynb#join>` for details
.. |FugueConfig| replace:: :ref:`the Fugue Configuration Tutorial <tutorial:/tutorials/useful_config.ipynb>`
.. |PartitionTutorial| replace:: :ref:`the Partition Tutorial <tutorial:/tutorials/partition.ipynb>`
.. |FugueSQLTutorial| replace:: :ref:`the Fugue SQL Tutorial <tutorial:/tutorials/sql.ipynb>`
.. |DataFrameTutorial| replace:: :ref:`the DataFrame Tutorial <tutorial:/tutorials/schema_dataframes.ipynb#dataframe>`
.. |ExecutionEngineTutorial| replace:: :ref:`the ExecutionEngine Tutorial <tutorial:/tutorials/execution_engine.ipynb>`



fugue.rpc.base
--------------

.. automodule:: fugue.rpc.base
:members:
:undoc-members:
:show-inheritance:

fugue.rpc.collections
---------------------

.. automodule:: fugue.rpc.collections
:members:
:undoc-members:
:show-inheritance:

fugue.rpc.flask
---------------

.. automodule:: fugue.rpc.flask
:members:
:undoc-members:
:show-inheritance:

1 change: 1 addition & 0 deletions docs/api/fugue.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ fugue
fugue.dataframe
fugue.execution
fugue.extensions
fugue.rpc
fugue.workflow

.. |SchemaLikeObject| replace:: :ref:`Schema like object <tutorial:/tutorials/x-like.ipynb#schema>`
Expand Down
8 changes: 8 additions & 0 deletions docs/api/fugue.workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ fugue.workflow



fugue.workflow.module
---------------------

.. automodule:: fugue.workflow.module
:members:
:undoc-members:
:show-inheritance:

fugue.workflow.workflow
-----------------------

Expand Down
8 changes: 4 additions & 4 deletions fugue/execution/execution_engine.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,8 @@ def persist(
:param lazy: ``True``: first usage of the output will trigger persisting
to happen; ``False`` (eager): persist is forced to happend immediately.
Default to ``False``
:param *args: parameter to pass to the underlying persist implementation
:param *kwargs: parameter to pass to the underlying persist implementation
:param args: parameter to pass to the underlying persist implementation
:param kwargs: parameter to pass to the underlying persist implementation
:return: the persisted dataframe
:Notice:
Expand Down Expand Up @@ -386,7 +386,7 @@ def fillna(
if dictionary, fills NA using the keys as column names and the
values as the replacement values.
:param subset: list of columns to operate on. ignored if value is
a dictionary
a dictionary
:param metadata: dict-like object to add to the result dataframe,
defaults to None
:type metadata: Any, optional
Expand Down Expand Up @@ -446,7 +446,7 @@ def take(
:param n: number of rows to return
:param presort: presort expression similar to partition presort
:param na_position: position of null values during the presort.
can accept ``first`` or ``last``
can accept ``first`` or ``last``
:param partition_spec: PartitionSpec to apply the take operation
:param metadata: dict-like object to add to the result dataframe,
defaults to None
Expand Down
5 changes: 3 additions & 2 deletions fugue/workflow/workflow.py
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,8 @@ def fillna(self: TDF, value: Any, subset: List[str] = None) -> TDF:
if dictionary, fills NA using the keys as column names and the
values as the replacement values.
:param subset: list of columns to operate on. ignored if value is
a dictionary
a dictionary
:return: dataframe with NA records filled
"""
params = dict(value=value, subset=subset)
Expand Down Expand Up @@ -637,7 +638,7 @@ def take(self: TDF, n: int, presort: str = None, na_position: str = "last") -> T
:param n: number of rows to return
:param presort: presort expression similar to partition presort
:param na_position: position of null values during the presort.
can accept ``first`` or ``last``
can accept ``first`` or ``last``
:return: n rows of DataFrame per partition
"""
Expand Down

0 comments on commit d9d125a

Please sign in to comment.