Skip to content

Conversation

@dsyme
Copy link
Collaborator

@dsyme dsyme commented Sep 14, 2020

@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

@codecov
Copy link

codecov bot commented Sep 14, 2020

Codecov Report

Merging #184 into dev will not change coverage.
The diff coverage is 0.00%.

Impacted file tree graph

@@           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           
Impacted Files Coverage Δ
src/DiffSharp.Core/DiffSharp.fs 36.34% <0.00%> (ø)
src/DiffSharp.Core/Distributions.fs 67.90% <ø> (ø)
src/DiffSharp.Core/Model.fs 62.45% <ø> (ø)
src/DiffSharp.Core/Optim.fs 82.83% <ø> (ø)
src/DiffSharp.Core/Tensor.fs 71.31% <ø> (ø)

@dsyme
Copy link
Collaborator Author

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
Copy link
Collaborator Author

dsyme commented Sep 15, 2020

@gbaydin I'll pull this now

@dsyme dsyme merged commit 36f56d5 into DiffSharp:dev Sep 15, 2020
@gbaydin
Copy link
Member

gbaydin commented Sep 19, 2020

@dsyme thanks, I think it's OK and it was a good time to merge it.

I add

... tags everywhere. This is because I'd eventually expect most docs in this repo to use math (...) and [...]

This makes sense.

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 dotnet/fsharp#10118. That will appear in upcoming editions of Visual Studio and F# support in VS Code

Looking forward to using it. Exciting improvements with documentation tools.

I worked on making sure we can add examples too e.g. https://github.com/DiffSharp/DiffSharp/pull/184/files#diff-4db1087bc965bcae8b149b068e5b186cR14

Minor: I couldn't see the example there. Am I missing something?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants