Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

docs: Woefully inadequate docstrings #336

Open
johnandersen777 opened this issue Jan 22, 2020 · 1 comment
Open

docs: Woefully inadequate docstrings #336

johnandersen777 opened this issue Jan 22, 2020 · 1 comment
Labels
documentation Changes to documentation
Milestone

Comments

@johnandersen777
Copy link

We are seriously lacking in our docstrings.

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html#example-numpy

https://intel.github.io/dffml/master/api/repo.html

@johnandersen777 johnandersen777 added the documentation Changes to documentation label Jan 22, 2020
@johnandersen777
Copy link
Author

I added the first examples here:

  • https://intel.github.io/dffml/master/api/db/sql.html
  • dffml/dffml/db/sql.py

    Lines 107 to 122 in 8c5dfa3

    Creates insert query. Keys in ``data`` dict correspond to the columns in
    ``table_name``.
    Parameters
    ----------
    table_name : str
    Name of the table.
    data : dict, optional
    Columns names are keys, values are data to insert.
    Returns
    -------
    query : str
    ``INSERT`` query
    parameters : tuple
    Variables to bind

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Changes to documentation
Projects
None yet
Development

No branches or pull requests

1 participant