Skip to content

Commit

Permalink
Update some docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
mariuzka committed Jan 31, 2025
1 parent 8e02850 commit 33eaaf0
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions src/pop2net/location_designer.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,12 @@ def setup(self) -> None:
def filter(self, agent: _agent.Agent) -> bool: # noqa: ARG002
"""Check whether the agent is meant to join this type of location.
This is a boilerplate implementation of this method which always returns True; i.e. all
agents will always be allowed at this location. Override this method in your own
implementations as you seem fit.
Args:
agent: The agent that is currently processed by the Creator.
Returns:
True if the agent is allowed to join the location, False otherwise.
Returns True by default.
"""
return True

Expand Down Expand Up @@ -116,10 +113,6 @@ def melt(self) -> list[Location] | tuple[Location]:
"""
return []

def refine(self):
"""An action that is performed after all location instances have been created."""
pass

def _subsplit(self, agent: _agent.Agent) -> str | float | list | None: # noqa: ARG002
"""Splits a location instance into sub-instances to create a certain network structure.
Expand Down

0 comments on commit 33eaaf0

Please sign in to comment.