CommanderStorm commented on PR #638:
URL: 
https://github.com/apache/arrow-rs-object-store/pull/638#issuecomment-3889974431

   > out-of-sync risk
   
   Shure, that is always a risk.
   
   Cannot have better docs without either
   - adding macro-complexity or
   - documenting it.
   
   I would be very motivated to take on this maintenance burden.
   
   Obviously, there is no way for you to trust me to keep my word on this one.
   What we could do is to revisit this in a year, since I have only been at 
this for a few months -> 
https://github.com/maplibre/martin/commits/main/docs/src/pmtiles
   
   This being markdown has the advantage that consumers can more easily consume 
this documentation into their documentation (aka without relying on rustdoc 
json).
   
   > Due to the limited nature of markdown, this is gonna be hard to replicate 
in a table view
   
   Warnings work alright.
   
   The datatypes are also not documented for the Enum way, but I think they 
should be fairly obvious by having an example.
   
   
https://github.com/CommanderStorm/arrow-rs-object-store/blob/a8cf83ee59c001a5529db0cb95a21c13b5a002a8/src/aws/config.md#aws-specific-request-behavior--fallbacks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to