Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Connection.open/2 typespecs #197

Closed
wants to merge 1 commit into from

Conversation

britto
Copy link

@britto britto commented Jun 11, 2021

To better document all the 3 possible argument combinations and make them stricter:

  • uri, name
  • options, name
  • uri, options

The previous spec covered invalid combinations, such as (keyword, keyword) and made it a bit hard to understand the possibilities without diving into the source code.

Output preview

Screen Shot 2021-06-11 at 15 32 15

To document all the 3 possible argument combinations:

* uri, name
* options, name
* uri, options
@britto
Copy link
Author

britto commented Jun 11, 2021

Oh, just saw #167. Looks like we're favoring passing :name through options instead, so we'd better not advertise the older (soon to be deprecated?) format.

@britto britto closed this Jun 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant