Skip to content

Commit

Permalink
write doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
SKairinos committed Mar 4, 2024
1 parent a47fcb4 commit 9b4f433
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
10 changes: 9 additions & 1 deletion .submodules/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@
© Ocado Group
Created on 02/03/2024 at 23:46:28(+00:00).
TODO: write script description.
This file is used to configure CFL's submodules using the global-config defined
in the config.jsonc file in this directory.
By default, the global-config is *merged* into any existing config within each
submodule. That is, any values defined in the global-config will override the
values found in a submodule's config but if a submodule has key:value pairs not
present in the global-config, they will remain. However, in some cases, the
behavior is to override the values (values not present in the global-config will
be removed).
"""

import json
Expand Down
16 changes: 15 additions & 1 deletion .submodules/config.jsonc
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
// TODO: Write comment
// This file is used to define a global-config for the submodules within CFL's
// workspace. This saves us having to manually repeat common configurations
// across 2+ submodules and avoids human error when accidentally copy/pasting
// something incorrectly.
//
// WARNING: This file is written in JSONC format (JSON with comments). However,
// only single lines comments with no preceding text are allowed. For example:
// - "// single-line comment, no preceding text" ✅
// - "{"age": 27} // single-line comment, some preceding text" 🚫
// - "/* multi-line comment, no preceding text */" 🚫
// - "{"age": 27} /* multi-line comment, some preceding text */" 🚫
//
// This config is processed by the __main__.py file in this directory. To
// understand more about this shape of the config data and how it's processed,
// please read __main__.py.
{
"base": {
"description": "Base configuration to be inherited by all other configurations.",
Expand Down

0 comments on commit 9b4f433

Please sign in to comment.