archesproject / arches-docs

official repo for Arches documentation
https://arches.readthedocs.io
9 stars 20 forks source link

Add new section: Naming Conventions #346

Closed kfogel closed 1 year ago

kfogel commented 1 year ago

Right now, this new section just holds one subsection, documenting one convention: "id vs _id: ID as Primary Key vs Foreign Key" (as discussed in PR #345). There are probably other naming conventions in the Arches code, though, and now at least there's a place to document them when we think of them (although it remains to be seen whether "Data Model" is the right place for all this -- perhaps the entire "Naming Conventions" section will need to be moved eventually).


kfogel commented 1 year ago

@mradamcox, @ekansa: ready for review, as promised in PR #345. I looked around but I'm still not sure I've put this new content in the best place; if there's a better location for it in the docs, feel free to just point me to it and I'll update this PR accordingly.

kfogel commented 1 year ago

Thanks for the fast review, @ekansa!

kfogel commented 1 year ago

W00t! Thank you, @ekansa.