Comments (4)
The interfaces are only used to allow calling resource methods in a dynamic like way without resorting to full reflection. They probably shouldn't be public, but then godoc readers wouldn't have been able to find the signatures of the methods their resources needed to have. The only use I can see for the interfaces to a programmer using rest.go is documenting the method signatures that can be called if they are implemented. As such, the interfaces would never be used in place of an actual type (that being the actual type created to implement the resource) such as io.Reader, where that naming convention makes sense.
Also, some of the names become weird. For example the Options interface would become Optionser.
So, if you have an example where the interface name is used outside of the rest.go core code, and have suggestions on how to rename them (or possibly the functions they require) I am happy to consider the suggestion.
Nathan
from rest.
Ok, thanks for pointing that out.
I/We’ll see about that.
from rest.
I have made those interfaces private and wrote better documentation to highlight the methods that can be called.
from rest.
I especially like the new README.
Documenting how to use rest.go was what I was looking into as well. :)
from rest.
Related Issues (7)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rest.