G-Node / nix

Neuroscience information exchange format
https://readthedocs.org/projects/nixio/
Other
66 stars 36 forks source link

[docs] NIX file validity and rules for validator #791

Closed achilleas-k closed 4 years ago

achilleas-k commented 4 years ago

I was working on making sure the rules for the NIXPy validator match the one in this library and while reading through the validator code, writing down all the rules, I figured I might as well make available for documentation purposes.

I can imagine several target users for this document:

This was written based entirely on the validator code, so if there's anything that's wrong, it might also be a mistake in the validator itself. There might also be some things that aren't expressed clearly, so let me know what you think.

Also not that I haven't linked to this file from anywhere else in the docs, so let me know if you want me to reference it from any of the other documents.

jgrewe commented 4 years ago

one quick comment even without reading: Thank you! The other thing is that you used markdown, but if we wanted to include it in the read-the-docs, we should use rst instead. I always wanted to remove the md files but kept them for reference ...

codecov[bot] commented 4 years ago

Codecov Report

Merging #791 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #791   +/-   ##
=======================================
  Coverage   95.34%   95.34%           
=======================================
  Files         197      197           
  Lines       12212    12212           
=======================================
  Hits        11644    11644           
  Misses        568      568

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 789e1bc...dba459f. Read the comment docs.

gicmo commented 4 years ago

Nice!