Skip to content

Commit 4bd19cb

Browse files
committed
Add top level module docstring to orient new user
I like how modules provide some basic documentation or at least pointers when I do something like "numpy?" in the IPython shell.
1 parent accac8e commit 4bd19cb

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

dandi/__init__.py

+15
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
"""
2+
DANDI
3+
=====
4+
5+
The `dandi <https://github.com/dandi/dandi-cli>`_ library provides both a
6+
command line interface (CLI) and a Python API for interacting with `DANDI
7+
Archive <https://dandiarchive.org>`_.
8+
9+
Additional references:
10+
11+
- `Source Git repository <https://github.com/dandi/dandi-cli>`_
12+
- `Library documentation <https://dandi.readthedocs.io/>`_
13+
- `DANDI Archive handbook <https://www.dandiarchive.org/handbook/>`_
14+
"""
15+
116
import logging
217
import os
318

0 commit comments

Comments
 (0)