Update 1wf_01_debugging.md #2897
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the debugging page, some examples regarding print debugging were added, and a link to the stdlib documentation
cuihtlauac
requested changes
Jan 6, 2025
There was a problem hiding this comment.
Thanks @patrick-nicodemus, this is useful. Here are some suggestions.
Comment on lines
+164
to
+165
| Print debugging is assisted by compiler builtins that allow a printed error | ||
| message to refer to the program location that the error was raised from. |
There was a problem hiding this comment.
Suggested change
| Print debugging is assisted by compiler builtins that allow a printed error | |
| message to refer to the program location that the error was raised from. | |
| Compiler builtins improve debugging messages. The location of the error in the program can be displayed. |
Comment on lines
+173
to
+177
| The compiler builtin `__LOC__` is substituted at compile time with the | ||
| location it occurs in the program, described as a string | ||
| "File %S, line %d, characters %d-%d". | ||
| One can also get the file name, line number, start character and | ||
| end character directly through the __POS__ builtin: |
There was a problem hiding this comment.
Suggested change
| The compiler builtin `__LOC__` is substituted at compile time with the | |
| location it occurs in the program, described as a string | |
| "File %S, line %d, characters %d-%d". | |
| One can also get the file name, line number, start character and | |
| end character directly through the __POS__ builtin: | |
| At compile time, the `__LOC__` builtin is substituted with its location in the program, described as a string `"File %S, line %d, characters %d-%d"`. One can also get the file name, line number, start character and end character directly through the `__POS__` builtin: |
Comment on lines
+188
to
+189
| Documentation for all debugging compiler builtins is in the | ||
| [standard library documentation](https://ocaml.org/manual/5.2/api/Stdlib.html#1_Debugging). |
There was a problem hiding this comment.
Suggested change
| Documentation for all debugging compiler builtins is in the | |
| [standard library documentation](https://ocaml.org/manual/5.2/api/Stdlib.html#1_Debugging). | |
| Compiler builtins are described in the | |
| [standard library](https://ocaml.org/manual/5.2/api/Stdlib.html#1_Debugging) documentation. |
Comment on lines
+170
to
+171
| | None -> Printf.printf "Invalid message at %s" __LOC__; flush stdout; | ||
| raise Invalid_argument |
There was a problem hiding this comment.
Suggested change
| | None -> Printf.printf "Invalid message at %s" __LOC__; flush stdout; | |
| raise Invalid_argument | |
| | None -> (Printf.eprintf "Invalid message at %s" __LOC__; raise Invalid_argument) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the debugging page, some examples regarding print debugging were added, and a link to the stdlib documentation