Live data from Hacker News

“This is the worst documentation I have ever seen in my life”

github.com

11–20 of 112 posts

Re: “This is the worst documentation I have ever seen in my life”

#12
post #5

Just an FYI. This is about Amazon's MWS API, which is Merchant Web Services, used to interact with the Amazon part of Amazon not the AWS side of Amazon. Also having working on an OSS Ruby library for it, and having to had work with it quite a bit, I can confirm. The MWS APIs leave a lot to be desired of, but they are an absolute gem compared to the Ebay APIs. My take on the problem is that these APIs were developed i…

Agree with what you have said about the MWS API, but this repo is actually the updated REST based API - which appears to be mostly the same functions as the older API but with less documentation.

Re: “This is the worst documentation I have ever seen in my life”

#13

We need a way to unit test documentation to see if the code snippets still compile and the things that are referenced still exist.

Sphinx supports this for Python: https://www.sphinx-doc.org/en/master/usage/extensions/doctes...

Re: “This is the worst documentation I have ever seen in my life”

#15
post #7

I won't touch any of amazon's products with a 10ft pole because of the way they treat their warehouse workers. Making their warehouse employees pee in bottles to make their metrics or risk being fired, that's just on a whole new level of extracting every joule of work out of a human being.

fair but wildly off-topic.

Re: “This is the worst documentation I have ever seen in my life”

#16

We need a way to unit test documentation to see if the code snippets still compile and the things that are referenced still exist.

obligatory "Rust docs can do this"[0] (quite a nice feature tbh). [0] https://doc.rust-lang.org/rustdoc/documentation-tests.html

Python can too, and I think most other languages are inspired by it.

https://docs.python.org/3/library/doctest.html

Re: “This is the worst documentation I have ever seen in my life”

#17
post #5

Just an FYI. This is about Amazon's MWS API, which is Merchant Web Services, used to interact with the Amazon part of Amazon not the AWS side of Amazon. Also having working on an OSS Ruby library for it, and having to had work with it quite a bit, I can confirm. The MWS APIs leave a lot to be desired of, but they are an absolute gem compared to the Ebay APIs. My take on the problem is that these APIs were developed i…

This is not the MWS API. The MWS Api was indeed written more than 10 years ago but is much better than this new "REST" api.

This is Selling Partner API which was released few months back and is intended to replace MWS.

Re: “This is the worst documentation I have ever seen in my life”

#18

We need a way to unit test documentation to see if the code snippets still compile and the things that are referenced still exist.

Sphinx supports this for Python: https://www.sphinx-doc.org/en/master/usage/extensions/doctes...

This is actually something from Python's stdlib: https://docs.python.org/3/library/doctest.html

Really underrated.

Re: “This is the worst documentation I have ever seen in my life”

#19

We need a way to unit test documentation to see if the code snippets still compile and the things that are referenced still exist.

This is why I prefer to link to actual code in the repo, in an examples directory, which gets compiled during every build.

This is not only simple and comprehensive but also doesn't require any special support from the tooling or language. Love it!

Re: “This is the worst documentation I have ever seen in my life”

#20
post #7

I won't touch any of amazon's products with a 10ft pole because of the way they treat their warehouse workers. Making their warehouse employees pee in bottles to make their metrics or risk being fired, that's just on a whole new level of extracting every joule of work out of a human being.

It's been surprising to see how much better people tend to view Amazon vs. Walmart when Amazon is just the next iteration of megacorp retail consolidation in the same vein with an increasingly horrible record of employee exploitation and abuse.
Post reply on HN