couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From benkeen <...@git.apache.org>
Subject [GitHub] couchdb-fauxton pull request: Move Helpers.docs into constants.js
Date Mon, 24 Nov 2014 15:52:08 GMT
Github user benkeen commented on a diff in the pull request:

    https://github.com/apache/couchdb-fauxton/pull/164#discussion_r20798134
  
    --- Diff: app/addons/databases/resources.js ---
    @@ -31,8 +31,8 @@ function(app, FauxtonAPI, Documents) {
           });
         },
     
    -    documentation: function(){
    -      return "all_dbs";
    --- End diff --
    
    Yeah that would totally work. This is such a subtle point, but I guess I'd argue that
it's clearer with the long constants name. If the `documentation` method was `docUrl` or something
to clearly indicate that we're returning a documentation *URL*, I'd be more in favour of returning
the `all_dbs` string, because you could infer what it was just from looking at the code. However,
you still wouldn't know where to find the URL. At least with the long constant it's immediately
clear where the info's stored.
    
    But I'm okay with your suggestion. So it would return the uppercase constant name?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message