GithubHelp home page GithubHelp logo

Comments (1)

nickfloyd avatar nickfloyd commented on June 6, 2024 1

Hey @kamarcum thanks for all that you're doing to call out the need for consistency and patterns.

TL;DR - client.create_or_update_actions_secret(repo, name, options) | Much like what we did here - reactions are the quintessential example for name collision

Even though it makes a bit more code / work I personally favor esoteric method names over parameter overloading. i.e. Clarity over obscurity.

My reasoning is that I believe that discoverability with APIs and SDK should be paramount (acknowledging that SDKs should also not 1:1 maps for APIs - there's a balance)

SDKs are meant to make consumption of various resources more approachable and also to abstract mundane and the known (like authentication and paging) away so that users don't have to repeat themselves.

All this to say, I feel that we should favor concrete over clever whenever we can - to best serve our new and existing consumers.

Thanks again for this! It's such a good call out! ❤️

from octokit.rb.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.