angular-restmod
angular-restmod copied to clipboard
platanus
Updated Documentation?
A lot of the documentation doesn't map to how the library currently works. Is there a place I'm missing that might have updated documentation?
Yes, there are a ton of inconsistencies. Currently trying to upgrade from 0.18.0 to 1.1.3 so I can stay on top of breaking changes and take advantage of any new features/improvements but it's slow-going due to documentation issues.
Where are these inconsistencies located? There are currently two documentation sources, the README and the reference at http://platanus.github.io/angular-restmod/, it would be very helpful to know where the documentation errors are.
The library went through a big refactoring during the transition to 1.0 and 1.1, I tried to keep the docs as updated as posible, but since there are no tests for the docs (well, actually there are some but is a wip), I depend on manual scanning of the code and issues reports.
I hope you can help me find these errors, I will gladly correct them asap.
I think also, more exhaustive documentation would be good. For example you mention that you can set the JSON root and metadata properties, but I can't find anywhere in the documentation where it shows how to actually do that. I looked at the tests in order to figure that out. There's a lot of similar things like that in the documentation.
I'll try to find some time to go through the docs again and see where it was inconsistent.
