Skip to content

Commit

Permalink
clarify docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lmiq committed Nov 22, 2024
1 parent 336ec10 commit 04dc8b5
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/src/elements.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,27 @@ add_element!
remove_custom_elements!
```

## Additional property-retrieving functions

The following functions are supported as part of the API, as a intending to interface
with `AtomsBase`. Nevertheless, currently these functions do not overload the exported
ones from `AtomsBase`, because that package is in a unstable state.

| Function | Example | Output |
|:-----------|:----------------------|:-------:|
|`atomic_number(::PDBTools.Atom)` | `atomic_number(Atom(name="NE2"))` | `7` |
|`atomic_symbol(::PDBTools.Atom)` | `atomic_symbol(Atom(name="NE2"))` | `:N` |
|`atomic_mass(::PDBTools.Atom)` | `atomic_mass(Atom(name="NE2"))` | `14.0067` |
|`position(::PDBTools.Atom)` | `position(Atom(name="NE2"))` | `SVector{3,Float64}(0,0,0)` |


```@docs
atomic_number
atomic_symbol
atomic_mass
position
```




0 comments on commit 04dc8b5

Please sign in to comment.