search

spiral-project / daybed

Form validation and data storage API
http://daybed.rtfd.org/
BSD 3-Clause "New" or "Revised" License
53 stars 8 forks source link

Some documentation improvements #254

Closed magopian closed 9 years ago

magopian commented 9 years ago

Please proof-read this very carefully, documentation is important, and I don't know much about daybed yet, so I could very possibly be wrong about some of those modifications.

Also, if you have a better idea than replacing all the v1 everywhere in the URLs on the next version (like using a variable or something), please let me know (i've checked ext_link and rst_epilog, but none seem to do the job... or be usable in code blocks).

Natim commented 9 years ago

Except for this little comments it is a great job. Thank you for taking the time to work on this.

leplatrem commented 9 years ago

Yeah good job, thanks a lot!

I will review the part about the object field type ASAP! But in brief: either you provide the name of an existing model or a list of fields like a definition, but not both.

I am not a fan of the way we manage the v1 prefix. IHMO it belongs to deployment strategy and should not be set by default ( nor in development...)

magopian commented 9 years ago

I'm glad to help, just let me know what you need me to modify ;)

almet commented 9 years ago

I agree that this prefix, on dev server is a bit ugly, but the best place to put the version prefix is in the code itself, and I think having this in dev forces us to see problems before they arise on a deployed stack (the fewer differences we have between the deployed stack and our dev env, the best luck we have to find what's wrong, if any).

magopian commented 9 years ago

Not sure if you noticed, I added a third commit to give some examples on using the geo fields. Let me know if they make sense ;)

magopian commented 9 years ago

Thanks a lot for the review! I updated accordingly.

leplatrem commented 9 years ago

Excellent :) Thanks !!