Skip to content

Pass name to websockex#23

Merged
roznawsk merged 2 commits intomasterfrom
pass-options-to-websockex
Jul 19, 2023
Merged

Pass name to websockex#23
roznawsk merged 2 commits intomasterfrom
pass-options-to-websockex

Conversation

@roznawsk
Copy link
Copy Markdown
Member

No description provided.

@roznawsk roznawsk requested review from LVala and mickel8 July 18, 2023 13:28
@codecov
Copy link
Copy Markdown

codecov bot commented Jul 18, 2023

Codecov Report

Merging #23 (94f6419) into master (172366c) will increase coverage by 0.10%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master      #23      +/-   ##
==========================================
+ Coverage   80.54%   80.64%   +0.10%     
==========================================
  Files           9        9              
  Lines         185      186       +1     
==========================================
+ Hits          149      150       +1     
  Misses         36       36              
Impacted Files Coverage Δ
lib/jellyfish/notifier.ex 84.72% <100.00%> (+0.21%) ⬆️

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 172366c...94f6419. Read the comment docs.

Comment thread lib/jellyfish/notifier.ex Outdated
Comment on lines +78 to +79
@spec start_link(options()) ::
{:ok, pid()} | {:error, term()}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should fit into one line, shouldn't it? The same for start/1

Comment thread lib/jellyfish/notifier.ex Outdated
server_api_token: "your-jellyfish-token",
secure?: true
```
First, [configure the connection options](https://hexdocs.pm/jellyfish_server_sdk/readme.html#jellyfish-connection-configuration).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer not to redirect to the README

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it would be nicer to put the description in Client moduledoc?

Comment thread README.md Outdated
secure?: true
```

Alternatively, the connection options can be provided when creating a `Jellyfish.Client` or starting `Jellyfish.Notifier` instead of using config:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Alternatively, the connection options can be provided when creating a `Jellyfish.Client` or starting `Jellyfish.Notifier` instead of using config:
Alternatively, the connection options can be provided when creating a `Jellyfish.Client` or starting `Jellyfish.Notifier`:

Comment thread lib/jellyfish/notifier.ex Outdated
server_api_token: "your-jellyfish-token",
secure?: true
```
First, [configure the connection options](https://hexdocs.pm/jellyfish_server_sdk/readme.html#jellyfish-connection-configuration).
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it would be nicer to put the description in Client moduledoc?

@roznawsk roznawsk merged commit fae650f into master Jul 19, 2023
@roznawsk roznawsk deleted the pass-options-to-websockex branch July 19, 2023 13:48
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.

3 participants