Skip to content

Conversation

@bagerard
Copy link
Collaborator

@bagerard bagerard commented Apr 28, 2019

Fix the fact that some important members (e.g: to_json, validate, clean, etc) of Document/EmbeddedDocument/etc classes aren't displayed in the Api reference doc because they are defined in the parent (BaseDocument)

This was noticed in #549

@bagerard bagerard mentioned this pull request Jun 10, 2019
@wojcikstefan
Copy link
Member

@bagerard, do you have any quick tips on the best way to review such PRs? How do I quickly see the before vs after of the docs?

Apologies – been a long time since I've built/reviewed those 😅

@wojcikstefan
Copy link
Member

@erdenezul any tips for reviewing the end result of PRs such as this one?

@erdenezul
Copy link
Collaborator

@wojcikstefan nothing particular

@erdenezul
Copy link
Collaborator

the validate method's doc including in Document

@wojcikstefan
Copy link
Member

Right, but do you build the docs locally via sphinx @erdenezul or is there an easier way to look at them?

@erdenezul
Copy link
Collaborator

@wojcikstefan Yes I built it locally

@wojcikstefan
Copy link
Member

Alright, I followed the steps from https://github.com/MongoEngine/mongoengine/blob/master/CONTRIBUTING.rst#documentation and built the docs locally as well, thanks!

Updated docs LGTM. I wish our docstrings for Document.clean and Document.get_text_score were clearer, but we can tackle that separately.

Thanks @bagerard & @erdenezul !

@wojcikstefan wojcikstefan merged commit 4a89852 into MongoEngine:master Jun 12, 2019
@bagerard
Copy link
Collaborator Author

Thanks for including this

@bagerard bagerard deleted the add_inherited_members_documents_doc branch June 14, 2019 19:16
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.

4 participants