search

fslaborg / Deedle

Easy to use .NET library for data and time series manipulation and for scientific programming
http://fslab.org/Deedle/
BSD 2-Clause "Simplified" License
924 stars 196 forks source link

Sample code snippet and introduction for the fslab website #531

Open kMutagene opened 2 years ago

kMutagene commented 2 years ago

Hi there, awesome work on this library!

As I will be talking about FsLab next week at .NET Conf: Focus on F#, there might be some new traffic on that page, therefore I extended the introduction parts (click on read more) of the libraries I maintain with some more introductory text and simple code snippets.

The packages page contains flips as well as a part of the fslab toolbox. If you would like to add some text/snippets, the markdown file that renders the flips card is located here (it has just been the project summary for the last months). Here is the same for Plotly.NET as reference.

I would say i am proficient enough in using Deedle to come up with some simple code myself, but i first wanted to ask if maybe a maintainer would like to control what exactly is presented on the website.

Cheers!

zyzhu commented 2 years ago

Thanks for the great efforts promoting Deedle via FsLab. Please go ahead with a getting-started sample. I trust your judgements. Users will be redirected here for more docs.

I'm more worried about how to maintain the current doc generation. Migrating to latest FSharp.Formatting is not trivial. Tomas put in various type specific formats for Frame and Series. It won't work with the latest version as fsdocs gets rid of doc generating scripts. And there is separate docs for C# samples. Anyway, I need to find time to work on it. If you have any spare time, feel free to take a look too. Thanks!

kMutagene commented 2 years ago

Cool, i added a very simple snippet.

Regarding the docs: I think as long as custom fsi evaluators are used, Deedle docs still have to use FSharp.Formatting as a library instead of a dotnet tool, but that does not mean that it can't use the new styling and functions.

Depending on the kind of formatting functions it might be worth looking into the way we solved this in Plotly.NET: Adding html formatters to the library which can then be used in both the formatting for dotnet interactive as well as the documentation with the fsdocs tool without custom evaluators. Maybe something like a ToHTMLTable() member additionally to Print(). I will take a look at the current documentation after the conference and maybe we can find a way to port them with this approach.