docs: improve docs (DEV-1478) #249
Conversation
| @@ -113,38 +115,6 @@ The following fields are optional (if one or more of these fields are not used, | |||
| - groups | |||
| - users | |||
|
|
|||
| A simple example definition of the `project` object looks like this: | |||
There was a problem hiding this comment.
A complete example of a project is already given some lines above, so it doesn't make sense to repeat this here.
| @@ -426,7 +396,7 @@ example, the list "colors" could be imported as follows: | |||
| "en": "A list with categories" | |||
| }, | |||
| "nodes": [ | |||
| ... | |||
There was a problem hiding this comment.
This and other similar changes are just that PyCharm doesn't show that many problems. In the future, I'd like to look more frequently on the problems that are detected by PyCharm. But for this, I need to kick out the false positives.
There was a problem hiding this comment.
Understandable (but confirms my dislike for PyCharm ;-)... in any case, I'm sure you could deactivate specific warnings).
Another thing you could consider would be annotating the code block as jsonc not json, so that comments are allowed , and then have // ... where the ellipsis is
| @@ -11,7 +11,7 @@ The command to import an XML file on a DSP server is described [here](./dsp-tool | |||
|
|
|||
| The import file must start with the standard XML header: | |||
|
|
|||
| ```xml | |||
There was a problem hiding this comment.
If it's invalid XML, it's rather a pain that it is marked as XML. (PyCharm detects this as a problem)
There was a problem hiding this comment.
not a fan of this change, but if it makes your life better, go ahead
| @@ -427,76 +428,78 @@ Example of a property with a public and a hidden decimal value: | |||
| ### <geometry-prop> | |||
There was a problem hiding this comment.
I reorganised the docs of <geometry-prop>. In principle I just moved information from one place to the other, with only few real deletions.
| ```json | ||
| ``` |
There was a problem hiding this comment.
I think with that you remove syntax highlighting, which is good to have in my opinion
| @@ -426,7 +396,7 @@ example, the list "colors" could be imported as follows: | |||
| "en": "A list with categories" | |||
| }, | |||
| "nodes": [ | |||
| ... | |||
There was a problem hiding this comment.
Understandable (but confirms my dislike for PyCharm ;-)... in any case, I'm sure you could deactivate specific warnings).
Another thing you could consider would be annotating the code block as jsonc not json, so that comments are allowed , and then have // ... where the ellipsis is
| ```python | ||
| ``` |
There was a problem hiding this comment.
again, this removes syntax highlighting I think, which reduces readability
| @@ -11,7 +11,7 @@ The command to import an XML file on a DSP server is described [here](./dsp-tool | |||
|
|
|||
| The import file must start with the standard XML header: | |||
|
|
|||
| ```xml | |||
There was a problem hiding this comment.
not a fan of this change, but if it makes your life better, go ahead
# Conflicts: # docs/dsp-tools-excel2xml.md # docs/dsp-tools-usage.md
resolves DEV-1478