docs(project): Add docstrings to functions in project #541
Conversation
MarieS-WiMLDS
changed the title
MarieS-WiMLDS
changed the title
| @@ -41,6 +41,7 @@ def __init__( | |||
| @singledispatchmethod | |||
| def put(self, key: str, value: Any, on_error: Literal["warn", "raise"] = "warn"): | |||
| """Add a value to the Project. | |||
| If an item with the same key already exists, it replaces the value with the new one. | |||
There was a problem hiding this comment.
If an item with the same key already exists, its value is replaced by the new one.
| @@ -112,7 +113,17 @@ def put_item(self, key: str, item: Item): | |||
| self.item_repository.put_item(key, item) | |||
|
|
|||
| def get(self, key: str) -> Any: | |||
| """Get the value corresponding to `key` from the Project.""" | |||
| """Get and returns the value corresponding to `key` from the Project. | |||
There was a problem hiding this comment.
Returns the value corresponding to key from the Project.
| Raises | ||
| ------ | ||
| KeyError | ||
| Renders KeyError if the input key doesn't correspond to any item. |
There was a problem hiding this comment.
Raises a KeyError if the key does not correspond to any item.
| @@ -131,31 +142,96 @@ def get(self, key: str) -> Any: | |||
| raise ValueError(f"Item {item} is not a known item type.") | |||
|
|
|||
| def get_item(self, key: str) -> Item: | |||
| """Add the Item corresponding to `key` from the Project.""" | |||
| """Get and returns the Item corresponding to `key` from the Project. | |||
There was a problem hiding this comment.
Returns the item corresponding to key from the Project.
| Raises | ||
| ------ | ||
| KeyError | ||
| Renders KeyError if the input key doesn't correspond to any item.""" |
There was a problem hiding this comment.
Raises a KeyError if the key does not correspond to any item.
| Raises | ||
| ------ | ||
| KeyError | ||
| Renders KeyError if the input key doesn't correspond to any item. |
There was a problem hiding this comment.
Raises a KeyError if the key does not correspond to any item.
| return self.item_repository.keys() | ||
|
|
||
| def delete_item(self, key: str): | ||
| """Delete an item from the Project.""" | ||
| """Delete an item from the Project. |
There was a problem hiding this comment.
Deletes the item corresponding to key from the Project.
| self.item_repository.delete_item(key) | ||
|
|
||
| def put_view(self, key: str, view: View): | ||
| """Add a view to the Project.""" | ||
| self.view_repository.put_view(key, view) | ||
|
|
||
| def get_view(self, key: str) -> View: | ||
| """Get the view corresponding to `key` from the Project.""" | ||
| """Get the view corresponding to `key` from the Project. |
There was a problem hiding this comment.
Returns the view corresponding to key from the Project.
| Raises | ||
| ------ | ||
| KeyError | ||
| Renders KeyError if the input key doesn't correspond to any item. |
There was a problem hiding this comment.
Raises a KeyError if the key does not correspond to any view.
| Raises | ||
| ------ | ||
| KeyError | ||
| Renders KeyError if the input key doesn't correspond to any view. |
There was a problem hiding this comment.
Raises a KeyError if the key does not correspond to any view.
Add docstrings to the functions in the project class.