search

tripal / tripal_doc

Official Documentation for the Tripal Platform
https://tripaldoc.readthedocs.io/en/latest/
GNU General Public License v3.0
2 stars 3 forks source link

Add tables for field naming conventions #28

Closed Ferrisx4 closed 1 year ago

Ferrisx4 commented 1 year ago

Add tables derived from the notes taken during the 2023 Tripal Cofest in San Diego, CA Notes

For https://github.com/tripal/tripal_doc/issues/27

Ferrisx4 commented 1 year ago

@spficklin These are from some of the notes I took during the cofest. I know you had a number of other changes in mind, but @laceysanderson asked if I could get started with these. I think I have the syntax correct for what we agreed on while @srobb1 was building the field.

spficklin commented 1 year ago

Thanks @Ferrisx4 . I wish I had taken better notes when we were building that field because some of the thoughts I had about what was missing in the documentation have left me. I need to go back and watch the recording. But, I don't recall what table this is referring to? I do remember having a conversation about setting a standard for field naming, but I don't know what is meant by a table. Do you?

Ferrisx4 commented 1 year ago

The info from the notes I took best fit in to a pair of tables in the documentation, regarding the naming conventions for the fields files and their annotations, which is what I added.

laceysanderson commented 1 year ago

I'm going to merge this so it's available to others even though @spficklin hasn't gotten the check to verify. I'm sure this is correct but if not we'll just update with another PR.

spficklin commented 1 year ago

Sorry, I missed this! These naming conventions are good for core Tripal fields. The word "Default" in the naming conventions should be clarified. It's for core fields, whereas fields in extension modules probably shouldn't use the word "Default"

laceysanderson commented 1 year ago

It does say "In addition, for fields that will be included in Tripal Core, note the ‘Default’ designation" currently but we could do another PR to make sure it is really clear (especially for anyone who doesn't read the text but just jumps in to look at the table as a reminder.

spficklin commented 1 year ago

Yeah, we might want to make that more clear.