Comments (12)
/cc @jackfoxy please review http://forki.github.io/FSharpx.Collections/apidocs/index.html
from fsharpx.collections.
I will review. Give me some time I have a very busy day today. For the "final" merged library I want to suggest renaming "Heap" to "OrderedQueue" and keep aliases for Heap and PriorityQueue. I also have in mind a minor adjustment to the empty binding. I think too many potential users are not familiar with Heap or PriorityQueue, and this is a more descriptive name. (This is a pairing heap implementation, btw, for those who don't know.)
from fsharpx.collections.
It took me a long time, but I have some minor doc changes that I will submit with the next substantive push for this project.
from fsharpx.collections.
I want to improve something in the xml doc for the Heap collection, and found the project does not build to an xml doc file. Looking in build.fsx I also saw nothing that looks xml doc related.@forki how are the xml docs getting built?
from fsharpx.collections.
They are built with FSharp.Formatting during release build.
from fsharpx.collections.
The Heap.empty
function needs additional pop-up intellisense docs because it has a parameter, but this seems to have no affect:
///<summary>O(1). Returns a empty heap.</summary>
///<param name="isDescending">true: heap will sort descending.</param>
[<GeneralizableValue>]
val empty<'T when 'T : comparison> : bool -> Heap<'T>
Correctly builds the xmldoc
<member name="M:FSharpx.Collections.HeapModule.empty``1(System.Boolean)">
<summary>O(1). Returns a empty heap.</summary>
<param name="isDescending">true: heap will order descending.</param>
</member>
but the pop-up intellisense (testing in HeapTests.fs) only shows the summary. Is this because the project target framework is .NET 3.5? Is there any reason not to advance this project to 4.5, or at least 4.0?
from fsharpx.collections.
This stuff is used in 3.5 projects. Please keep it compatible
from fsharpx.collections.
Is there something I should do to get param intellisense to work in VS?
Empty and ofSeq are the only way to construct this collection, and the parameter is not intuitive.
The alternative I have thoughtof is to drop the parameter, make empty and ofSeq instantiate ascending order and add 2 new module functions, emptyDescending and ofSeqDescending. Of course that would be a breaking change and also undesireable.
from fsharpx.collections.
strange. Maybe we should use markdown XML comments like in FAKE.
from fsharpx.collections.
I temporarily turned on XML generation in the FSharpx.Collections project in order to observe the results in the FSharpx.Collections.Tests project. I think this methodology is sound for this test.
I have no experience with Markdown XML comments. Another alternative is to put the parameter information inside the summary part of the xml doc. This at least gets the message to the user.
from fsharpx.collections.
"parameter information inside the summary part of the xml"
That's basically what we do in MD style. We just omit the xml tags and everything goes into summary.
https://github.com/fsharp/FAKE/blob/develop/src/app/FakeLib/UnitTest/XUnitHelper.fs#L105 gets rendered to http://fsharp.github.io/FAKE/apidocs/fake-xunithelper.html
from fsharpx.collections.
Pretty sure this issue is obsolete.
from fsharpx.collections.
Related Issues (20)
- unique overload for CircularBuffer method 'Enqueue' could not be determined HOT 6
- Circular buffer does not enque arrays properly
- RandomAccessList is not serializable.
- Add LazyList.consLazy HOT 1
- Add static members for F#+ generic operators HOT 1
- Potential net45 support
- AppVeyor builds are not shown as PRs checks. HOT 5
- Travis build sometimes fails on downloading deps via Paket. HOT 3
- Namespaces used by the package and the approach to extending types already present in core lib are not consistent across the package.
- Align Collection Module functions with FSharp.Collections
- Is FSharp.Core >= 4.3.4 still desirable/necessary? HOT 4
- Add conversion of enum value to its string name HOT 1
- Fable compatibility HOT 6
- build fails, need to update FSharp.Formatting HOT 4
- Heap.Tail slow
- Fill gap of functions between `List` and `NonEmptyList`
- Can't use pre-release nuget packages? HOT 10
- Include source files in the Nuget package HOT 5
- Welcome gdziadkiewicz as co-maintainer! HOT 5
- Code style guidance for new structure HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from fsharpx.collections.