Modernize library structure #9
Conversation
Freymaurer
commented
Feb 4, 2021
Freymaurer
commented
- Use modern library "standards"
- Fix minor issues with ISAXLSXTests
- Add Fable compilable nuget package
|
|
||
| <PropertyGroup> | ||
| <Authors>nfdi4plants, Lukas Weil, Kevin Frey</Authors> |
There was a problem hiding this comment.
nfdi4plants is not really an Author, is it? I think if there is an Owners field, it should be moved there, together with HLWeil
There was a problem hiding this comment.
Owners is deprecated and authors should be used instead: https://docs.microsoft.com/de-de/nuget/reference/nuspec#owners
src/ISADotnet/API/Comment.fs
Outdated
| @@ -1 +1,40 @@ | |||
| namespace ISADotNet.API | |||
| namespace ISADotNet | |||
There was a problem hiding this comment.
Was this namespace change made by heart?
There was a problem hiding this comment.
Wait this fs is supposed to be in the datamodel folder
There was a problem hiding this comment.
Yeah this slip up propably happened during some merge conflicts, good catch! Changed it.
src/ISADotnet/DataModel/Comment.fs
Outdated
| @@ -1,41 +1 @@ | |||
| namespace ISADotNet | |||
There was a problem hiding this comment.
See comment above, this fs was actually supposed to stay in this folder
| <ItemGroup> | ||
| <Compile Include="JsonExtensions.fs" /> |
There was a problem hiding this comment.
Any reason for changing the compile order?
There was a problem hiding this comment.
Brought compile order more in line with previous version!
|
|
||
| <PropertyGroup> | ||
| <Authors>nfdi4plants, Lukas Weil, Kevin Frey</Authors> |
tmp/watch/0_Markdown-Cheatsheet.html
Outdated
| @@ -0,0 +1,471 @@ | |||
| <!DOCTYPE html> | |||
There was a problem hiding this comment.
What's up with these cheatsheets?
There was a problem hiding this comment.
Also should't all these files in the tmp folder be in the gitignore?
There was a problem hiding this comment.
The Markdown was part of the fslab-docs template, it can be removed.
Was not sure about this, but it makes sense.
build.fsx
Outdated
| // Git configuration (used for publishing documentation in gh-pages branch) | ||
| // The profile where the project is posted | ||
| let gitOwner = "nfdi4plants" | ||
| let gitName = "DataPLANT" |
There was a problem hiding this comment.
I think the gitName should be ISADotNet
docs/0_Markdown-Cheatsheet.md
Outdated
| @@ -0,0 +1,400 @@ | |||
| # Markdown cheatsheet | |||
There was a problem hiding this comment.
Not sure if we should keep this tutorial style documents here in this project
| @@ -1,6 +0,0 @@ | |||
| { | |||
There was a problem hiding this comment.
Just a bump to discuss this change
There was a problem hiding this comment.
i read a bit into this and will add a global.json again. This should improve reproducibility at the cost of building inconvinience. I also upped the required version to the newest .NET Core SDK version.
global.json
Outdated
| "sdk": { | ||
| "version": "3.1.400", | ||
| "rollForward": "latestFeature" |
There was a problem hiding this comment.
As, net5.0 is stable now, maybe we could switch the rollForward to latestMajor
build.fsx
Outdated
| let buildDocs = BuildTask.create "BuildDocs" [build; copyBinaries] { | ||
| printfn "building docs with stable version %s" stableVersionTag | ||
| runDotNet | ||
| (sprintf "fsdocs build --eval --clean --property Configuration=Release --parameters fsdocs-package-version %s" stableVersionTag) |
There was a problem hiding this comment.
Related to: #11
I think atm it would be good to add the --noapidocs flag until this API documentantion generation issue is resolved in FSharp.Formatting
