From 90640c04606bafee116d35ec16751468d1bc6660 Mon Sep 17 00:00:00 2001 From: Quin Gillespie Date: Sat, 14 Mar 2026 13:46:41 -0600 Subject: [PATCH] Improve grammar in OnError and StatusBar docs. --- Documentation/English/OnError.txt | 18 ++++----- Documentation/English/StatusBar.txt | 58 ++++++++++++++--------------- 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/Documentation/English/OnError.txt b/Documentation/English/OnError.txt index 5bd683f2..2431a6a1 100644 --- a/Documentation/English/OnError.txt +++ b/Documentation/English/OnError.txt @@ -11,7 +11,7 @@ @ReferenceLink "ide_debugger" "PureBasic debugger" but without the drawbacks of a bigger filesize and lower execution speed when using the debugger. This way the final version of a program which is shipped to the end user can still intercept program errors and provide some information about the error to the user - so he can report it back to the developer. + so they can report it back to the developer. @LineBreak @LineBreak The @ReferenceLink "ide_debugger" "PureBasic debugger" is still the better tool for finding bugs during the development phase, @@ -47,7 +47,7 @@ Changes the action taken if an error occurs to directly exit the program, even if the default action on the system is not to exit the program on this kind of error. The system may display an error dialog or print an error-message on the console on exit. - + @NoParameters @NoReturnValue @@ -62,7 +62,7 @@ OnErrorExit() Pokes(10, "Hello World") ; Cause a #PB_OnError_InvalidMemory error - + MessageRequester("OnError test", "This should never be displayed") @EndCode @@ -97,7 +97,7 @@ OnErrorCall(@ErrorHandler()) Pokes(10, "Hello World") ; Cause a #PB_OnError_InvalidMemory error - + MessageRequester("OnError test", "This should never be displayed") @EndCode @@ -114,7 +114,7 @@ @Parameter "?LabelAddress" The address of a label in the program to jump to. - + @NoReturnValue @Remarks @@ -130,10 +130,10 @@ OnErrorGoto(?ErrorHandler) Pokes(10, "Hello World") ; Cause a #PB_OnError_InvalidMemory error - + MessageRequester("OnError test", "This should never be displayed") End - + ErrorHandler: MessageRequester("OnError test", "The following error happened: " + ErrorMessage()) End @@ -156,7 +156,7 @@ @Remarks When using the OnError library inside a @ReferenceLink "dll" "DLL" the best practice is to set the error handler - at the beginning of every public DLL function and resetting it back to the default with this command + at the beginning of every public DLL function and reset it back to the default with this command before returning to the caller to make sure there is no interference between the OnError library and any exception handling done by the calling program. @@ -171,7 +171,7 @@ OnErrorCall(@ErrorHandler()) OnErrorDefault() ; Comment this to get the handler call instead of the system error handling Pokes(10, "Hello World") ; Cause a #PB_OnError_InvalidMemory error - + MessageRequester("OnError test", "This should never be displayed") @EndCode diff --git a/Documentation/English/StatusBar.txt b/Documentation/English/StatusBar.txt index 0a9f49ea..aec80a69 100644 --- a/Documentation/English/StatusBar.txt +++ b/Documentation/English/StatusBar.txt @@ -8,8 +8,8 @@ @Overview - A status bar is the bottom bar of a window where some information are displayed - on it. This bar is always visible and can be split in several parts. + A status bar is the bottom bar of a window where some information is displayed. + This bar is always visible and can be split into several parts. @CommandList @@ -22,32 +22,32 @@ @Function AddStatusBarField(Width) @Description - Adds a field to the current statusbar previously created with @@CreateStatusBar. - Each new field is created after the old one. - + Adds a field to the current status bar previously created with @@CreateStatusBar. + Each new field is created after the previous one. + @Parameter "Width" - The width of the new field in pixels. If sets to @#PB_Ignore then the field - will be resized to fill the remaining free space on the statusbar. Multiple fields can have a width of @#PB_Ignore, + The width of the new field in pixels. If set to @#PB_Ignore then the field + will be resized to fill the remaining free space on the status bar. Multiple fields can have a width of @#PB_Ignore, in which case the free space will be divided evenly among these fields. @NoReturnValue @Remarks - The following commands can be used to set or change the content of the statusbar field: + The following commands can be used to set or change the content of the status bar field: @LineBreak - @@StatusBarText @LineBreak - @@StatusBarImage @LineBreak - @@StatusBarProgress - + @LineBreak @LineBreak See @@CreateStatusBar for an example. @SeeAlso @@StatusBarText, @@StatusBarImage, @@StatusBarProgress, @@CreateStatusBar - + @SupportedOS ;-------------------------------------------------------------------------------------------------------- @@ -62,10 +62,10 @@ @Parameter "#StatusBar" A number to identify the new status bar. @ReferenceLink "purebasic_objects" "#PB_Any" can be used to auto-generate this number. - + @Parameter "WindowID" - The window on which the status bar needs to be created. @@WindowID can be used to get this value. - + The window on which the status bar should be created. @@WindowID can be used to get this value. + @ReturnValue Nonzero if the status bar has been successfully created, zero otherwise. @@ -83,7 +83,7 @@ StatusBarText(0, 1, "Area borderless", #PB_StatusBar_BorderLess) StatusBarText(0, 2, "Area right", #PB_StatusBar_Right) StatusBarText(0, 3, "Area centered", #PB_StatusBar_Center) - + Repeat Until WaitWindowEvent() = #PB_Event_CloseWindow EndIf @@ -101,7 +101,7 @@ @Description Free the given status bar. - + @Parameter "#StatusBar" The status bar to free. If @#PB_All is specified, all the remaining status bars are freed. @@ -120,7 +120,7 @@ Tests if the given status bar number is a valid and correctly initialized status bar. @Parameter "#StatusBar" - The status bar to use. + The status bar number to test. @ReturnValue Nonzero if the status bar is valid, zero otherwise. @@ -130,7 +130,7 @@ @SeeAlso @@CreateStatusBar - + @SupportedOS ;-------------------------------------------------------------------------------------------------------- @@ -138,16 +138,16 @@ @Function StatusBarImage(#StatusBar, Field, ImageID [, Appearance]) @Description - Sets the specified Field to display an image. - + Sets the specified status bar field to display an image. + @Parameter "#StatusBar" The status bar to use. - + @Parameter "Field" - The field index to set the image. The first field index starts from zero. - + The index of the field to put the image on. The first field index starts from zero. + @Parameter "ImageID" - The image to set to the specified statusbar field. It can be easily obtained by using @@ImageID. + The image to set to the specified status bar field. It can be easily obtained by using @@ImageID. @OptionalParameter "Appearance" It can be used to alter the look of the field with the following values: @@ -172,7 +172,7 @@ StatusBarImage(0, 0, ImageID(0)) StatusBarImage(0, 1, ImageID(0), #PB_StatusBar_Right) EndIf - + Repeat Until WaitWindowEvent() = #PB_Event_CloseWindow EndIf @@ -205,15 +205,15 @@ @Description Sets the text for the specified status bar field. - + @Parameter "#StatusBar" The status bar to use. - + @Parameter "Field" - The field index to set the text. The first field index starts from zero. - + The index of the field to set the text on. The first field index starts from zero. + @Parameter "Text$" - The text to set to the specified statusbar field. + The text to set to the specified status bar field. @OptionalParameter "Appearance" It can be used to alter the look of the field with the following values: