Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add descriptions/guidance for custom exceptions #1518

Open
Tracked by #1292
JimMadge opened this issue Jul 26, 2023 · 0 comments · May be fixed by #1873
Open
Tracked by #1292

Add descriptions/guidance for custom exceptions #1518

JimMadge opened this issue Jul 26, 2023 · 0 comments · May be fixed by #1873
Assignees
@craddm
Labels
enhancement New functionality that should be added to the Safe Haven
Milestone
Release 5.0.0rc2

Comments

@JimMadge
Copy link
Member

We have defined a number of custom exceptions to help with debugging and aid users.

data-safe-haven/data_safe_haven/exceptions/__init__.py

Lines 1 to 14 in f0a8906

class DataSafeHavenException(Exception):
pass
class DataSafeHavenCloudException(DataSafeHavenException):
pass
class DataSafeHavenConfigException(DataSafeHavenException):
pass
class DataSafeHavenInputException(DataSafeHavenException):
pass

Currently only the names indicate when they should be used.
It would be good to add some documentation (at least comments/docstrings) to explain when the exceptions are to be used (and when they shouldn't be used).
@JimMadge JimMadge mentioned this issue Jul 26, 2023
Merged
5 tasks
@JimMadge JimMadge changed the title Add descriptions/guidance for custom exceptions Pulumi: Add descriptions/guidance for custom exceptions Jul 26, 2023
@jemrobinson jemrobinson added this to the Python migration milestone Jul 26, 2023
@jemrobinson jemrobinson mentioned this issue Jul 26, 2023
Closed
52 tasks
@jemrobinson jemrobinson added the enhancement New functionality that should be added to the Safe Haven label Sep 13, 2023
@JimMadge JimMadge assigned craddm and unassigned jemrobinson and JimMadge May 9, 2024
@craddm craddm linked a pull request May 9, 2024 that will close this issue
Draft
4 tasks
@jemrobinson jemrobinson changed the title Pulumi: Add descriptions/guidance for custom exceptions Add descriptions/guidance for custom exceptions May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@craddm craddm

Labels
enhancement New functionality that should be added to the Safe Haven
Projects
None yet
Milestone
Release 5.0.0rc2
Development

Successfully merging a pull request may close this issue.

[WIP] Add comments/docstrings to exceptions craddm/data-safe-haven
3 participants
@jemrobinson @craddm @JimMadge