Uh oh!
There was an error while loading. Please reload this page.
Placeholders for documentation - #184
Conversation
Codecov Report
@@ Coverage Diff @@## dev #184 +/- ##
=======================================
Coverage 67.04% 67.04% =======================================
Files 13 13 Lines 4797 4797 Branches 1186 1187 +1 =======================================
Hits 3216 3216 Misses 924 924 Partials 657 657
|
dsyme
commented
Sep 15, 2020
Note: failure is just codecov/patch, we can ignore that @gbaydin Are you ok with us merging this? Best to get it in to avoid conflicts |
dsyme
commented
Sep 15, 2020
@gbaydin I'll pull this now |
gbaydin
commented
Sep 19, 2020
@dsyme thanks, I think it's OK and it was a good time to merge it.
This makes sense.
Looking forward to using it. Exciting improvements with documentation tools.
Minor: I couldn't see the example there. Am I missing something? |
@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