search

michaelbull / kotlin-result

A multiplatform Result monad for modelling success or failure operations.
ISC License
1.05k stars 63 forks source link

Are there plans for a website for documenting functionality? #43

Closed shalomhalbert closed 3 years ago

shalomhalbert commented 3 years ago

Due to the heavy usage of extension functions, it's difficult to find this library's functionality by looking through source code in the IDE. Look through the source code on Github is seemingly the best option for now

michaelbull commented 3 years ago

Right now there are no plans for an external website. We have the wiki which does go quite a long way in documenting the functions.

I wouldn't be opposed to a website though, provided the src was in the same repository. I suppose GitHub pages could be a solution?

shalomhalbert commented 3 years ago

Thank you for sharing the wiki, I should have checked earlier.

As a person with no knowledge of Elm, Rust, Haskell, or Scala the wiki is difficult to digest. Are you open to organizing it differently? Such as split it into Return and Either?

michaelbull commented 3 years ago

I'm open to adding more pages to the Wiki. The current structure is ideal for those who have had experience with the Return type that exists in other languages and that's the audience it was designed for, but we can always add more pages

shalomhalbert commented 3 years ago

Doesn't seem like there's a way for me to contribute to the wiki. Is that an incorrect understanding?

michaelbull commented 3 years ago

Looks like that's a GitHub limitation.

If you propose changes as markdown in this issue I'll go ahead and apply them manually.

shalomhalbert commented 3 years ago

I Will try to put up a PR next week

william-reed commented 3 years ago

@shalbert94 have you started any work on this? if not i may take it up

shalomhalbert commented 3 years ago

@william-reed, I have not. Thank you for offering