Skip to content

Commit 11c9acd

Browse files
docs: cleaned up docstrings
1 parent 7c6e476 commit 11c9acd

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

src/ursina_proteins/atoms.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,15 +75,15 @@ def __init__(
7575
**kwargs,
7676
):
7777
"""
78-
Create an entity to visualise atoms
78+
Create an entity to visualise atoms.
7979
8080
Args:
8181
atoms: Atoms to visualise.
82-
atom_size: Size of individual atoms in the atoms mesh.
82+
atom_size: Size of individual atoms.
8383
atom_vertices: Base vertices to use for atom geometry (default: None).
8484
atom_triangles: Base triangles to use for atom geometry (default: None).
8585
atom_normals: Base normals to use for atom geometry (default: None).
86-
element_color_map: Color mapping for atoms (default: None).
86+
element_color_map: Color mapping for atom elements (default: None).
8787
*args: Arguments passed to constructor for the entity.
8888
**kwargs: Keyword arguments passed to constructor for the entity.
8989
"""

src/ursina_proteins/chains.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ def __init__(
3838
**kwargs,
3939
):
4040
"""
41-
Create an entity to visualise helices and a subentity to visualise coils of chains
41+
Create an entity to visualise helices and a subentity to visualise coils of chains.
4242
4343
Args:
4444
chains: Chains to visualise.

src/ursina_proteins/protein.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def __init__(
4848
**kwargs,
4949
):
5050
"""
51-
Parse a protein structure file and create visualisation entities
51+
Parse a protein structure file and create visualisation entities.
5252
5353
Args:
5454
protein_filepath: Path to the protein file.
@@ -57,13 +57,13 @@ def __init__(
5757
chains_smoothness: Smoothness factor for chain rendering (default: 3).
5858
helices_thickness: Thickness of helix meshes (default: 4).
5959
coils_thickness: Thickness of coil meshes (default: 1).
60-
chain_id_color_map: Color mapping for chains (default: None).
60+
chain_id_color_map: Color mapping for chain IDs (default: None).
6161
compute_atoms: Flag to enable/disable atoms computation (default: True).
6262
atom_size: Size of individual atoms in the atoms mesh (default: 0.1).
6363
atom_vertices: Base vertices to use for atom geometry (default: None).
6464
atom_triangles: Base triangles to use for atom geometry (default: None).
6565
atom_normals: Base normals to use for atom geometry (default: None).
66-
atom_element_color_map: Color mapping for atoms (default: None).
66+
atom_element_color_map: Color mapping for atom elements (default: None).
6767
*args: Arguments passed to constructor for each entity.
6868
**kwargs: Keyword arguments passed to constructor for each entity.
6969
"""

0 commit comments

Comments
 (0)