Skip to content

Commit 1895021

Browse files
committed
model: Resource: Document raised exceptions for advanced operations
1 parent 6ae1e84 commit 1895021

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/crystal/model.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3388,6 +3388,9 @@ def try_normalize_url(self) -> bool:
33883388
"""
33893389
Tries to alter this resource's URL to be in normal form,
33903390
unless there is already an existing resource with that URL.
3391+
3392+
Raises:
3393+
* ProjectReadOnlyError
33913394
"""
33923395
new_url = self.normalized_url
33933396
if new_url == self._url:
@@ -3398,6 +3401,9 @@ def _try_alter_url(self, new_url: str) -> bool:
33983401
"""
33993402
Tries to alter this resource's URL to new specified URL,
34003403
unless there is already an existing resource with that URL.
3404+
3405+
Raises:
3406+
* ProjectReadOnlyError
34013407
"""
34023408
project = self.project # cache
34033409

@@ -3419,6 +3425,11 @@ def _try_alter_url(self, new_url: str) -> bool:
34193425

34203426
# NOTE: Only used from a Python REPL at the moment
34213427
def delete(self) -> None:
3428+
"""
3429+
Raises:
3430+
* ProjectReadOnlyError
3431+
* ValueError -- if this resource is referenced by a RootResource
3432+
"""
34223433
project = self.project
34233434

34243435
if project.readonly:

0 commit comments

Comments
 (0)