Something like Hoogle?

[atifaziz]

This discussion was forked out of PR #989.

@declard wrote:

Just an idea: in Haskell ecosystem (there is groupBy func with the same type signature as the one this PR adds, BTW) there is a tool called Hoogle which allows to search functions across libraries by their type and it's tremendously convenient, may it make sense to add type annotations to the functions descriptions in README.md? Like

Segment
[a] -> (a -> Bool) -> [[a]]
[a] -> (a -> Int -> Bool) -> [[a]]
[a] -> (a -> a -> Int -> Bool) -> [[a]]

The syntax is alien to C#, so there can be a better option, but it is extremely concise. I use similar pseudo-typelanguage in the extension lib on the project.

I guess I should open an issue for such discussion, don't I?

@viceroypenguin wrote:

That information is available in the public docs: https://morelinq.github.io/3.4/ref/api/html/Overload_MoreLinq_MoreEnumerable_Segment.htm

@declard wrote:

That information is available in the public docs: https://morelinq.github.io/3.4/ref/api/html/Overload_MoreLinq_MoreEnumerable_Segment.htm

yes, but imagine one comes into the docs, they want to find a suitable function by its type, they press Ctrl+F and type... what?

[atifaziz]

yes, but imagine one comes into the docs, they want to find a suitable function by its type, they press Ctrl+F and type... what?

I know Hoogle and it works really well for a Haskell developer who think in terms of types and function signatures and have built proficiency in reading those. When I was actively developing in LiveScript and using its prelude library, I really liked how it concisely expressed the logical transformation as simple signatures, replicate, like replicate: Number → a → [a], and you'll notice I've used those in title of some issues. I think doing something like that for MoreLINQ will serve a tiny fraction of the community. Perhaps something more useful would be group the various extensions instead of having a single flat list, like how it's done in the C# documentation section title, “Standard Query Operators Overview (C#)”:

• Sorting Data
• Set Operations
• Filtering Data
• Quantifier Operations
• Projection Operations
• Partitioning Data
• Join Operations
• Grouping Data
• Generation Operations
• Equality Operations
• Element Operations
• Converting Data Types
• Concatenation Operations
• Aggregation Operations

[viceroypenguin]

@atifaziz This is a good idea. I've implemented it in viceroypenguin/SuperLinq#359. You can observe the results here. Feel free to copy it back to morelinq if it's useful; some work will be required (mangling the doc links, remove async links, removing operators not implemented in morelinq).