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.

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

Add force_database_error documentation #6667

Merged
merged 2 commits into from
Jan 5, 2024

Conversation

Dhghomon
Copy link
Contributor

@Dhghomon Dhghomon commented Jan 5, 2024

Writing documentation for the UI today and noticed that force_database_error takes a str instead of a bool, and that the strs it accepts can be pretty verbose. Pretty nice feature to have compared to a simple bool so added two examples of valid input to get users started.

@Dhghomon Dhghomon marked this pull request as ready for review January 5, 2024 03:23
Copy link
Contributor

@raddevon raddevon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch! Would it also make sense to provide a link to a list of errors? Maybe https://github.com/edgedb/edgedb/blob/master/edb/errors/__init__.py

@Dhghomon
Copy link
Contributor Author

Dhghomon commented Jan 5, 2024

Nice catch! Would it also make sense to provide a link to a list of errors? Maybe https://github.com/edgedb/edgedb/blob/master/edb/errors/__init__.py

Yeah! Good call, I linked to the page containing them. (There's one in .rst format too)

@raddevon raddevon merged commit 23bb395 into master Jan 5, 2024
22 checks passed
@raddevon raddevon deleted the document-force-database-error branch January 5, 2024 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants