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

Typos in docs #2

Open
rebkwok opened this issue Jun 5, 2015 · 0 comments
Open

Typos in docs #2

rebkwok opened this issue Jun 5, 2015 · 0 comments

Comments

@rebkwok
Copy link

rebkwok commented Jun 5, 2015

usage.rst:
"Now you can store and lists of Wheels with your car"
Guessing "and" should be "a" or deleted

Attribute docstring:
struct_name (str, optional): The dict key to be used when serializing this attribute. Defaults to the name the attribute's name on its host ``Model``.
Should just be "the attribute's name"?
python_type (function, optional): A function that takes the serialized value and converts it to the type that will be stored on the Model instance. This parameter is the usually used with, and is the opposite of ``serialized_type``.
"This parameter is the usually used with" - something missing here
serialized_type (function, optional): A function that takes the value stored on the Model instance and returns the value that should be stored in the serialized dict. This parameter is the usually used with, and is the opposite of ``python_type``.
"This parameter is the usually used with" - ditto

BaseModelChoice docstring:
If records contain an attribute that specify the class...
Should either be "attributes that specify" or "an attribute that specifies"

Relation doctring:
Should Params be Args as in the Attribute docstring? Doesn't look like it's formatting properly in the docs.

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

No branches or pull requests

2 participants