@@ -18,7 +18,7 @@ error_msg = user_message("Operation failed. Please try again later.")
1818
1919## Guidelines for Updating User Messages
2020
21- When modifying user messages, follow these rules:
21+ When modifying user messages, follow ** as close as possible ** these rules:
2222
23231 . ** Version Tracking** : Every modification to a user message must include an incremented ` _version ` parameter:
2424
@@ -43,7 +43,7 @@ When modifying user messages, follow these rules:
4343 user_message(" Unable to load project." , _version = 1 )
4444 ```
4545
46- 3 . ** Message Style** : Follow * strictly* the guidelines in ` ${workspaceFolder}/docs/user-messages-guidelines.md `
46+ 3 . ** Message Style** : Follow ** strictly* * the guidelines in ` ${workspaceFolder}/docs/user-messages-guidelines.md `
4747
48484 . ** Preserve Context** : Ensure the modified message conveys the same meaning and context as the original.
4949
@@ -56,17 +56,19 @@ When modifying user messages, follow these rules:
5656 # After
5757 user_message(" Your session has expired. Please log in again." , _version = 3 )
5858 ```
59+ 6 . ** Replace 'Study' by 'Project'** : If the message contains the word 'Study', replace it with 'Project' to align with our terminology.
60+
5961
6062## Examples
6163
6264### Example 1: Simple Message Update
6365
6466``` python
6567# Before
66- error_dialog(user_message(" Failed to save changes." ))
68+ error_dialog(user_message(" Failed to save changes in this study ." ))
6769
6870# After
69- error_dialog(user_message(" Unable to save your changes. Please try again ." , _version = 1 ))
71+ error_dialog(user_message(" Unable to save your changes in this project ." , _version = 1 ))
7072```
7173
7274### Example 2: F-string Message Update
0 commit comments