Skip to content

"How to" docs/tests #4

Description

@thorwhalen

Write (and continuously update) documentation structured as a "how to" tutorial (or Problem/Solution).

Do this in a way that is testable so we assure that the docs are correct.
That is: Figure out how to test python from md docs, or generate them from testable code (see test2doc for example).
Figure out a way to mitigate imports visual noise. For example, using from mongodol import * and possibly any other needed imports at the top?

Here are questions to start with:

  • How do I add full (i.e. containing _id fields) docs to a collection, controlling for unicity (overwrites allowed or not, with or without warnings...)
  • How do I add a doc that doesn't have a _id?
  • How can I control _id creation, and possibly other fields created automatically at insertion (append?) time?
  • How can I get interfaces such as list.append, list.extend, set.add, or dict.update to mongo?
  • tuple keys: s[i,j]
  • Slicing: s[:, j], s[i_query, j]

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions