invalid example data file naming/commenting practice #1999
turbomam
started this conversation in
Schema Best Practices
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
It's nice to include some explanation for the invalidity in the file name, if it doesn't make the file name unreasonably long.
It's required if there are two or more invalid data files instantiating the same class.
But reducing complex explanations to two or three words could be stressful, so another option is including a YAML
#comment at the top of the example data file.Beta Was this translation helpful? Give feedback.
All reactions