Placeholders for documentation #184
Merged
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.
@gbaydin This adds about 500 placeholders for documentation. Not pretty but necesssary. Seems best to add them first and then fill things in as it makes the codebase still look consistent
I add
<summary>...</summary>tags everywhere. This is because I'd eventually expect most docs in this repo to use math\(...\)and\[...\]Let me know what you think
BTW
I worked on tooling to make F# IDE tools check docs as you type - it makes it so much easier to reliably write the docs Check XML doc parameter names for FSharp.Core via opt-in checking dotnet/fsharp#10118. That will appear in upcoming editions of Visual Studio and F# support in VS Code
I worked on making sure we can add examples too e.g. https://github.com/DiffSharp/DiffSharp/pull/184/files#diff-4db1087bc965bcae8b149b068e5b186cR14