Skip to content

Commit f1420b7

Browse files
committed
update best effort clause
1 parent 29f9a85 commit f1420b7

File tree

1 file changed

+2
-1
lines changed
  • contributor_docs/pr05_2025_typescript_migration

1 file changed

+2
-1
lines changed

contributor_docs/pr05_2025_typescript_migration/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,8 @@ export const updatePreferences: RequestHandler<
399399
Best-effort & evolving-precision principle towards defining types
400400
</summary>
401401

402-
- Make a best effort at being as precise as possible with context clues, but when in doubt, selecting a broader type (eg. `string` instead of an `enum`) is valid and we can update to be stricter as the migration continues.
402+
- Because we are adding types into a legacy project originally written without types, there are sometimes inconsistencies between component contracts, or misalignments between type shapes or name conventions that make adding in types difficult.
403+
- As such make a best effort at being as precise as possible with context clues, but when in doubt, selecting a broader type (eg. `string` instead of an `enum`) is valid and we can update to be stricter as the migration continues.
403404

404405
</details>
405406

0 commit comments

Comments
 (0)