Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
phoenixr-codes committed Aug 17, 2023
1 parent 6b3b4fd commit f7a8b67
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ struct = Structure(
```


## Viewing a Structure
## Inspecting a Structure

```python
struct.size # The size of the structure
Expand All @@ -32,6 +32,15 @@ struct.get_structure() # Get the numpy array representing the structure
```


## Viewing a Structure

You can simply print the structure object:

```python
print(struct)
```


## Modifying a Structure

Simple modifications such as placing blocks:
Expand Down

0 comments on commit f7a8b67

Please sign in to comment.