250 Commits

Author SHA1 Message Date
Bastien Gerard
1b7c2085c9 Fix for imprecise doc on collection name (CamelCase -> snake_case) 2021-02-21 21:17:49 +01:00
Peter Nerlich
460df112f4
Fix inconsistency with example
connection example shows a password of 12345, but text spoke of qwerty
2021-01-10 23:43:46 +01:00
Bastien Gerard
3926473917 Improve Fields documentation + remove versionadded/changed as it's not maintained 2020-12-06 22:25:12 +01:00
Bastien Gérard
91493a1e79 improve migration doc 2020-11-12 00:40:52 +01:00
Bastien Gérard
0c274908ec Merge branch 'master' of github.com:MongoEngine/mongoengine into add_migration_documentation 2020-11-11 21:18:52 +01:00
Bastien Gérard
746faceb5c Document fact that srv URI can be used with host #1956 2020-11-08 22:55:24 +01:00
Bastien Gérard
f8d371229e tmp work on migration doc 2020-11-01 20:25:35 +01:00
Mateusz Stankiewicz
c9d53ca5d5 Add EnumField 2020-10-30 13:06:37 +01:00
Bastien Gérard
015a36c85f minor styling fix in .rst 2020-10-19 23:59:12 +02:00
Bastien Gérard
3fca3739de rework validation documentation based on review 2020-10-18 21:11:16 +02:00
Bastien Gérard
c218c8bb6c Merge branch 'master' of github.com:MongoEngine/mongoengine into add_validation_to_doc 2020-10-17 15:05:27 +02:00
Bastien Gérard
7f77084e0e minor fixes in doc links 2020-08-12 21:56:38 +02:00
Filip Kucharczyk
2be28a22a7
Merge branch 'master' into fix/add-dev-tools 2020-03-27 15:15:14 +01:00
Bastien Gérard
ee2d50b2d1 remove drop_dups index option, deprecated with MongoDB3 2020-03-17 21:38:50 +01:00
Bastien Gérard
152b51fd33 improve gridfs example (properly opening file) 2019-12-29 14:36:50 +01:00
Bastien Gérard
e7c7a66cd1 improve doc of GridFS, emphasize that subsequent call to read() requires to rewind the file with seek(0) 2019-12-27 10:38:03 +01:00
Bastien Gérard
aa02f87b69 change & deprecate .aggregate api to mimic pymongo's interface + separate the aggregation tests from the large test_queryset.py file 2019-12-27 09:23:15 +01:00
Bastien Gérard
1170de1e8e added explicit doc for order_by #2117 2019-12-20 23:20:15 +01:00
Bastien Gérard
332bd767d4 minor fixes in tests 2019-12-20 23:20:15 +01:00
erdenezul
0053b30237
Merge pull request #2217 from bagerard/improve_inheritance_doc
provide additional details on how inheritance works in doc
2019-12-20 22:43:45 +01:00
Bastien Gérard
280a73af3b minor fix in doc of NULLIFY to improve #834 2019-12-14 21:44:59 +01:00
Bastien Gérard
3b099f936a provide additional details on how inheritance works in doc 2019-12-13 21:32:45 +01:00
Filip Kucharczyk
37ffeafeff Replace 'pip' with 'python -m pip install' in docs 2019-12-05 01:13:05 +01:00
Filip Kucharczyk
17151f67c2 Reformat repo with pre-commit hooks 2019-12-05 00:53:39 +01:00
Bastien Gérard
c60ed32f3a Documented how pymongo.monitoring can be used with MongoEngine 2019-10-16 21:25:17 +02:00
Bastien Gérard
be2c4f2b3c fix formatting and improve doc based on review 2019-09-16 21:15:35 +02:00
Bastien Gérard
7ac74b1c1f Document Model.objects.aggregate entrypoint with an example 2019-09-15 23:27:34 +02:00
Bastien Gérard
d37a30e083 improve doc (based on review) 2019-06-30 20:46:40 +02:00
Bastien Gérard
c9ed930606 Add a documentation page for validation 2019-06-25 22:31:48 +02:00
Stefan Wójcik
ae0384df29
Improve Document.meta.shard_key docs (#2099)
This closes #2096. Previous documentation of the shard_key meta attribute was
missing the crucial point that it really only matters if your collection is
sharded over a compound index.
2019-06-20 11:25:51 +02:00
Bastien Gérard
70d6e763b0 Document the custom field validation feature 2019-06-05 22:23:54 +02:00
Bastien Gérard
5bf1dd55b1
Update mongomock example
Improved the mongomock example as reported in #2067 
 
Fixes #2067
2019-06-04 22:56:52 +02:00
Bastien Gérard
048a045966
Update connection/multiple databases docs
I observed that many people were confused by this so I thought I'd make the multiple databases example more explicit
2019-06-04 21:47:28 +02:00
Bastien Gérard
b1e28d02f7 Improve connect/disconnect
- document disconnect + sample of usage
- add more test cases to prevent github issues regressions
2019-04-24 22:44:07 +02:00
lalala223
48b849c031
Update querying.rst
Fix the 'not' operator error example.
2019-03-13 17:50:54 +08:00
G Roques
e7000db491 Add LongField to Fields list 2018-12-29 13:08:39 -06:00
amir-almusawi
48a691e722 fixed small typographical error 2018-12-07 22:08:05 -06:00
erdenezul
18b47e4a73
Merge pull request #1932 from bagerard/improve_index_doc
minor improvement to index doc
2018-10-25 10:19:04 +08:00
Bastien Gérard
c685ace327 minor improvement to index doc 2018-10-23 23:55:55 +02:00
Bastien Gérard
f23b0faf41 fix some asserts in no_dereference doc 2018-10-23 22:10:34 +02:00
Bastien Gérard
83fe7f7eef Document the index option and the fact that additional options gets forwarded to pymongo's create_index method 2018-10-22 21:54:46 +02:00
Bastien Gérard
d6e39b362b Updating inheritance doc
Fixes #429
2018-09-09 14:52:08 +02:00
Bastien Gérard
a86092fb64 fix doc for meta index_options 2018-09-06 22:33:33 +02:00
erdenezul
5a091956ef
Merge pull request #1862 from bagerard/document_name_param_for_indexes
Documented that it is possible to specify a 'name' for the indexes (using the dict definition)
2018-09-03 17:20:17 +08:00
Bastien Gérard
a3bcf26dce Merge branch 'master' of https://github.com/MongoEngine/mongoengine into pmatos_patch-1 2018-09-02 15:27:37 +02:00
Bastien Gérard
bd524d2e1e Documented that it is possible to specify a name when using a dict to define an index 2018-09-01 00:12:49 +02:00
Bastien Gérard
461b789515 relates to (#710)
- Update gridfs.rst to make it clearer that you should save the Document hosting the GridFSProxy after calling .delete() or .replace() on the GridFSProxy
- updated GridFSProxy.__str__ so that it would always print both the filename and the grid_id. This should improve debugging
2018-08-19 23:45:08 +02:00
Bastien Gérard
1a2b1f283b Update signals doc - clarification on EmbeddedDocument
Since there is a .save() method on EmbeddedDocument, you could be tempted to attach a pre_save event to an EmbeddedDocument (#1720). This update is an attempt to make this clearer.
2018-08-13 22:16:32 +02:00
JoschSan
820f7b4d93
Update connecting.rst
My suggest is append the parameter in authentication_source in authentication example, because was included in https://github.com/MongoEngine/mongoengine/pull/590/files
2018-08-07 14:29:15 -04:00
erdenezul
765038274c
Merge pull request #1691 from rcscott/document-auto-create-index
Add documentation for auto_create_index to the Indexing section of the Docs
2018-05-21 08:55:25 +08:00