Opened 7 years ago
Closed 7 years ago
#28578 closed Cleanup/optimization (fixed)
Rename DatabaseCreation.clone_test_db() argument from number to suffix
| Reported by: | Jon Dufresne | Owned by: | nobody |
|---|---|---|---|
| Component: | Database layer (models, ORM) | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
Recently, I had the need to use DatabaseCreation.clone_test_db(). The function has the argument number. number is concatenated to the end of the database name to create the test database name. This value does not need to be a number nor is it used numerically. Any string will do. In my use case, I was using a random string, not a number. Therefore, I find the current name misleading and inaccurate. I suggest the name suffix instead.
DatabaseCreation.clone_test_db(), DatabaseCreation._clone_test_db(), and DatabaseCreation.get_test_db_clone_settings() are not documented functions. So I believe no deprecation path is required.
DatabaseCreation.destroy_test_db(), which also has the number argument, is documented, but the number argument is not part of that documentation. I'm not sure if this is intentional or an oversight. But if intentional, again, I believe no deprecation path is required.
If I'm misunderstanding and a deprecation path is required, please let me know.
Change History (3)
comment:1 by , 7 years ago
| Has patch: | set |
|---|
comment:2 by , 7 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|
PR