search

rethinkdb / horizon-docs

Other
24 stars 36 forks source link

Documentation should probably use camelCase in code examples #91

Closed mlucy closed 8 years ago

mlucy commented 8 years ago

I was reading the docs on http://horizon.io/docs/embed/ and it uses underscores in variable names for the JS examples.

chipotle commented 8 years ago

Does the Horizon object accept option keys in camelCase, or just snake_case as shown here? (For that matter, are the instance methods camelCase or snake_case? AFAICT it's add_auth_provider(), not addAuthProvider().)

mlucy commented 8 years ago

Right now the options have to be snake_case (I opened https://github.com/rethinkdb/horizon/issues/620 to complain about that). I could see an argument for leaving the variable names in snake_case until the API changes so that the examples aren't mixing styles, if you think that would be better.