Fantomas.Core documentation #2394
Merged
Conversation
This file contains hidden or 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
dawedawe reviewed Aug 1, 2022
Member
dawedawe left a comment
dawedawe left a comment There was a problem hiding this comment.
Wow, this is super useful work. Much appreciated.
| As a final step in the process, we validate the result of the code generation. | ||
| We do this by parsing the existing code and investigating the fsharp diagnostics. | ||
| When there are any warnings or errors, we will throw an exception. | ||
| Some warnings are are allowed as they indicate problems that were most likely already present in the input code. |
Member
There was a problem hiding this comment.
Suggested change
| Some warnings are are allowed as they indicate problems that were most likely already present in the input code. | |
| Some warnings are allowed as they indicate problems that were most likely already present in the input code. |
| </div> | ||
| | ||
| Unfortunately, both phases are not always very straight forward. | ||
| But once you get hang of the first phase, you can easily understand the second phase. |
Member
There was a problem hiding this comment.
Suggested change
| But once you get hang of the first phase, you can easily understand the second phase. | |
| But once you get the hang of the first phase, you can easily understand the second phase. |
dawedawe approved these changes Aug 1, 2022
Contributor Author
| Many thanks for the review @dawedawe! |
nojaf force-pushed the contributors-doc branch 3 times, most recently from cf2daf3 to 87cdd15 Compare 
Co-authored-by: dawe <dawedawe@posteo.de>
alanlomeli approved these changes Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
An initial few pages for #2320.
When reviewing this you might want to read it locally using:
https://github.com/fsprojects/fantomas/blob/8593cb20c867699bedc6a9c5c735fa4532db27ed/docs/.README.md
Enjoy!
PS: @yisusalanpng is working on the styling in #2377