pim/pg-rad
1
0
Fork 0
mirror of https://github.com/pim-n/pg-rad synced 2026-03-23 21:58:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

improve docstrings for future comptability with mkdocs

Browse Source
This commit is contained in:
Pim Nelissen
2026-01-28 08:43:07 +01:00
parent f9ff50f4ef
commit d162f9fee3
4 changed files with 57 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/pg_rad/objects.py
View File

@ -11,6 +11,16 @@ class Object:
z: float,
name: str = "Unnamed object",
color: str = 'grey'):
"""
A generic object.
Args:
x (float): X coordinate.
y (float): Y coordinate.
z (float): Z coordinate.
name (str, optional): Name for the object. Defaults to "Unnamed object".
color (str, optional): Matplotlib compatible color string. Defaults to "red".
"""
self.x = x
self.y = y
@ -35,7 +45,7 @@ class Source(Object):
isotope: Isotope,
name: str | None = None,
color: str = "red"):
"""_A point source._
"""A point source.
Args:
x (float): X coordinate.
@ -47,7 +57,8 @@ class Source(Object):
Defaults to None, making the name sequential.
(Source-1, Source-2, etc.).
color (str, optional): Matplotlib compatible color string. Defaults to "red".
"""
"""
self.id = Source._id_counter
Source._id_counter += 1