Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: usage #8

Merged
merged 1 commit into from
Aug 12, 2016
Merged

docs: usage #8

merged 1 commit into from
Aug 12, 2016

Conversation

omelkonian
Copy link
Contributor

@omelkonian omelkonian commented Aug 8, 2016

  • Adds complete usage documentation.

Signed-off-by: Orestis Melkonian melkon.or@gmail.com

in this example we use an in-memory SQLite database):

>>> from invenio_db import db
>>> db.init_app(app)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

>>> from invenio_db import InvenioDB, db
>>> db_ext = InvenioDB(app)

see https://github.com/inveniosoftware/invenio-pidstore/blob/master/invenio_pidstore/__init__.py#L58-L64

@omelkonian omelkonian changed the title global: documentation docs: usage Aug 12, 2016
be always passed as keyword arguments on each instantiation. No exception
is raised in case of redundant keyword arguments.

For examples, see :ref:`User-defined keywords`.
Copy link
Member

@jirikuncar jirikuncar Aug 12, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can find more examples in :ref:...

or like before: For more in-depth example, see

* Adds complete usage documentation.

Signed-off-by: Orestis Melkonian <melkon.or@gmail.com>
@jirikuncar
Copy link
Member

LGTM

@jirikuncar jirikuncar merged commit 83b8d72 into inveniosoftware:master Aug 12, 2016
@omelkonian omelkonian deleted the docs branch August 12, 2016 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants