Skip to content

Function signature differences between fetchSolc and fetchAndLoadSolc are confusing #11

Description

@gnidan

As indicated by issue #10, the README(s) could likely do a better job of guiding the user from fetchAndLoadSolc to separated fetchSolc and loadSolc. At least one data point shows that the docs might want to provide a hint or some kind of additional clarity, so that the user takes note that fetchAndLoadSolc takes fetch: options and load: options separately, but when you split things up, there is no outer wrapper.

The wording in this issue probably does nothing to improve clarity here, but, uh, probably just some kind of one-line notice can be placed in the fetchSolc section of the README to indicate "if you were using fetchAndLoadSolc, don't forget to remove the outer fetch: wrapper".

Alternatively, maybe there's a code change that would either make this more polymorphic (sounds bad, though), or a code change that would make the distinction more clear via errors or warnings.

Alternatively alternatively, the one data point above is insufficient evidence to call this a problem, and this issue might be closable as won't-fix.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions