Skip to content

Commit

Permalink
changed Troubleshooting Tips to Troubleshooting in docs error hea…
Browse files Browse the repository at this point in the history
…ding
  • Loading branch information
nh916 committed Sep 22, 2023
1 parent 79b7c33 commit 75486df
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions src/cript/nodes/exceptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class CRIPTNodeSchemaError(CRIPTException):
* The format of the JSON the CRIPT Python SDK created was invalid
1. There is something wrong with the database schema
## Troubleshooting Tips
## Troubleshooting
The easiest way to troubleshoot this is to examine the JSON that the SDK created via printing out the
[Project](../../nodes/primary_nodes/project) node's JSON and checking the place that the schema validation
says failed
Expand Down Expand Up @@ -74,7 +74,7 @@ class CRIPTJsonDeserializationError(CRIPTException):
```json
```
## Troubleshooting Tips
## Troubleshooting
"""

def __init__(self, node_type: str, json_str: str) -> None:
Expand Down Expand Up @@ -118,7 +118,7 @@ class CRIPTDeserializationUIDError(CRIPTException):
```
Now the node is fully specified.
## Troubleshooting Tips
## Troubleshooting
Specify the full node instead. This error might appear if you try to partially load previously generated JSON.
"""

Expand Down Expand Up @@ -174,7 +174,7 @@ class CRIPTJsonNodeError(CRIPTJsonDeserializationError):
```
## Troubleshooting Tips
## Troubleshooting
Debugging skills are most helpful here as there is no one-size-fits-all approach.
It is best to identify whether the invalid JSON was created in the Python SDK
Expand Down Expand Up @@ -207,7 +207,7 @@ class CRIPTJsonSerializationError(CRIPTException):
## Definition
This Exception is raised if serialization of node from JSON to Python Object fails.
## Troubleshooting Tips
## Troubleshooting
"""

def __init__(self, node_type: str, json_dict: str) -> None:
Expand Down Expand Up @@ -259,7 +259,7 @@ class CRIPTOrphanedNodesError(CRIPTException, ABC):
If there is a material node that is used within a project but not a part of the
inventory and the validation code finds it then it raises an `CRIPTOrphanedNodeError`
## Troubleshooting Tips
## Troubleshooting
Fixing this is simple and easy, just take the node that CRIPT Python SDK
found a problem with and associate it with the appropriate parent via
Expand All @@ -281,7 +281,7 @@ class CRIPTOrphanedMaterialError(CRIPTOrphanedNodesError):
## Definition
CRIPTOrphanedNodesError, but specific for orphaned materials.
## Troubleshooting Tips
## Troubleshooting
Handle this error by adding the orphaned materials into the parent project or its inventories.
"""

Expand All @@ -301,7 +301,7 @@ class CRIPTOrphanedExperimentError(CRIPTOrphanedNodesError):
## Definition
CRIPTOrphanedNodesError, but specific for orphaned nodes that should be listed in one of the experiments.
## Troubleshooting Tips
## Troubleshooting
Handle this error by adding the orphaned node into one the parent project's experiments.
"""

Expand Down Expand Up @@ -343,7 +343,7 @@ class CRIPTOrphanedDataError(CRIPTOrphanedExperimentError):
## Definition
CRIPTOrphanedExperimentError, but specific for orphaned Data node that should be listed in one of the experiments.
## Troubleshooting Tips
## Troubleshooting
Handle this error by adding the orphaned node into one the parent project's experiments `data` attribute.
"""

Expand All @@ -357,7 +357,7 @@ class CRIPTOrphanedProcessError(CRIPTOrphanedExperimentError):
CRIPTOrphanedExperimentError, but specific for orphaned Process node that should be
listed in one of the experiments.
## Troubleshooting Tips
## Troubleshooting
Handle this error by adding the orphaned node into one the parent project's experiments
`process` attribute.
"""
Expand All @@ -372,7 +372,7 @@ class CRIPTOrphanedComputationError(CRIPTOrphanedExperimentError):
CRIPTOrphanedExperimentError, but specific for orphaned Computation node that should be
listed in one of the experiments.
## Troubleshooting Tips
## Troubleshooting
Handle this error by adding the orphaned node into one the parent project's experiments
`Computation` attribute.
"""
Expand All @@ -387,7 +387,7 @@ class CRIPTOrphanedComputationalProcessError(CRIPTOrphanedExperimentError):
CRIPTOrphanedExperimentError, but specific for orphaned ComputationalProcess
node that should be listed in one of the experiments.
## Troubleshooting Tips
## Troubleshooting
Handle this error by adding the orphaned node into one the parent project's experiments
`ComputationalProcess` attribute.
"""
Expand Down

0 comments on commit 75486df

Please sign in to comment.