Verified Commit 610f52cc authored by Qusai Al Shidi's avatar Qusai Al Shidi 💬

tecplot documentation fixes

parent 6de2102c
Pipeline #25937 passed with stage
in 50 seconds
......@@ -637,15 +637,21 @@ This is helpful for accessing Tecplot variables.
**Examples**:
In a dataset which contains the variable 'X [R]',
```print(dataset.variable_names)
>>> ['X [R]', ... ]```
```python
print(dataset.variable_names)
# ['X [R]', ... ]
```
The following will fail:
```print(dataset.variable('X [R]').name)
>>> TecplotPatternMatchWarning: no variables found matching: "X [R]" For
```python
print(dataset.variable('X [R]').name)
# TecplotPatternMatchWarning: no variables found matching: "X [R]" For
a literal match, the meta-characters: * ? [ ] must be wrapped in square-
brackets. For example, "[?]" matches the character "?"...```
# For example, "[?]" matches the character "?"...
```
However,
```print(dataset.variable(tpt.bracketify('X [R]')).name)```
```python
print(dataset.variable(tpt.bracketify('X [R]')).name)
```
will succeed.
<a name="swmfpy.tecplottools.write_zone"></a>
......
......@@ -271,15 +271,21 @@ def bracketify(variable_name: str) -> str:
Examples:
In a dataset which contains the variable 'X [R]',
```print(dataset.variable_names)
>>> ['X [R]', ... ]```
```python
print(dataset.variable_names)
# ['X [R]', ... ]
```
The following will fail:
```print(dataset.variable('X [R]').name)
>>> TecplotPatternMatchWarning: no variables found matching: "X [R]" For
```python
print(dataset.variable('X [R]').name)
# TecplotPatternMatchWarning: no variables found matching: "X [R]" For
a literal match, the meta-characters: * ? [ ] must be wrapped in square-
brackets. For example, "[?]" matches the character "?"...```
# For example, "[?]" matches the character "?"...
```
However,
```print(dataset.variable(tpt.bracketify('X [R]')).name)```
```python
print(dataset.variable(tpt.bracketify('X [R]')).name)
```
will succeed.
"""
translation = {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment