search

open-campaign-logger / generator-library

This repository contains the generator library files for https://campaign-logger.com/generator which can be referenced like this: "{lib:adjColor}".
Apache License 2.0
31 stars 13 forks source link

Recommended commenting method? #1

Closed evesala closed 6 years ago

evesala commented 7 years ago

As the JSON format does not have an official syntax for comments, is there a recommended method for adding notes (explanations, development ideas, issues, etc.) to the tables?

Something that would be included in the file itself would be much more usable than just commit notes.

JochenLinnemann commented 7 years ago

We could easily add an "explanation" property of type string to generators and tables. This shouldn't interfere with the generator.

evesala commented 7 years ago

That would be great! Explanations could be useful also for storing meta data, such as date and version notes.

JochenLinnemann commented 7 years ago

I just created a branch and added a file to try out and show-case new format extensions: https://github.com/open-campaign-logger/generator-library/blob/extended-file-format/json/_file-format.json

Please feel free to add your thoughts there, too.

evesala commented 6 years ago

Have been successfully using explanation (as well as several other metadata properties) for some time now. Thanks!