search

com-lihaoyi / os-lib

OS-Lib is a simple, flexible, high-performance Scala interface to common OS filesystem and subprocess APIs
Other
680 stars 67 forks source link

API Documentation #179

Closed ysthakur closed 1 year ago

ysthakur commented 1 year ago

I don't know if scaladocs for OS-Lib already exist but I wasn't able to find them so I'm assuming they don't. Apologies if they already do and this issue is unnecessary.

I know OS-Lib is a small library and pretty much everything's documented in the Readme, but it'd still be nice to have API docs. If the maintainers think that's something worth having, I'd be happy to submit a PR (using GitHub Pages).

SethTisue commented 1 year ago

maybe just add an appropriate https://javadoc.io link to the readme? I think it's become less common for projects to publish Scaladoc/Javadoc themselves, since javadoc.io does such a good job with it

ysthakur commented 1 year ago

I didn't know javadoc.io existed, that's really cool! For Scala, it's slightly complicated by the fact that there's different os-lib_3, os-lib_2.13, etc. artifacts, but I guess since they all use the same code cross-compiled to different Scala versions, only one of os-lib_3 or os-lib_2.13 would have to be linked to.