adlfs icon indicating copy to clipboard operation
adlfs copied to clipboard

ENH: Augment examples in readme?

Open nickeubank opened this issue 4 years ago • 3 comments

The README on this repo seems to be the only documentation for this package, and I think there's a lot of functionality missing (e.g. there's a reference at the bottom to being able to write to Azure, but no discussion of how that works? And I see issues about tools that allow for exploring Azure storage file names and structure (e.g. https://github.com/dask/adlfs/issues/135). Any chance some of that could end up in the package docs? Seems like there's a lot of great functionality in this package that may not be discoverable...

nickeubank avatar Nov 30 '20 16:11 nickeubank

@nickeubank -- There has definitely been updates to the package that are not included in the docs. Any and all improvements are appreciated!

hayesgb avatar Dec 12 '20 15:12 hayesgb

I would contribute, but I don't have a clue what all the improvements are! I only realized looking at the issues that there's a lot that I don't know about.

nickeubank avatar Dec 12 '20 15:12 nickeubank

related to this https://github.com/dask/adlfs/issues/103

exploring Azure storage file names and structure

True. Most of that info is held upstream at fsspec or s3fs which is more mature (same syntax)

raybellwaves avatar Dec 21 '20 14:12 raybellwaves