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

Clarify the usage of custom type #137

Merged
merged 1 commit into from
Oct 5, 2024

Conversation

c4710n
Copy link
Contributor

@c4710n c4710n commented Sep 28, 2024

Before, the doc uses mod.fun(values, ...args) to describe the usage of custom type. However, it failed to clearly explain the underlying approach, because ... is not a valid syntax of Elixir.

This PR try to clarify the usage by referring the underlying call.

Although covering the underlying implementation in the documentation is not ideal, it is likely the easiest way to understand how things work, especially since developers are indeed required to implement certain aspects here.

@coveralls
Copy link

coveralls commented Sep 28, 2024

Pull Request Test Coverage Report for Build 5c3e5232b809373b9d4bf7cc3960d2acbff4e0b5-PR-137

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 93.448%

Totals Coverage Status
Change from base Build 1d269dc7b03b027be4d880d52b8ad8d406e4580e: 0.0%
Covered Lines: 271
Relevant Lines: 290

💛 - Coveralls

lib/nimble_options.ex Outdated Show resolved Hide resolved
@whatyouhide whatyouhide merged commit aee4686 into dashbitco:main Oct 5, 2024
2 checks passed
@whatyouhide
Copy link
Collaborator

Thank you! 💟

@c4710n c4710n deleted the zd/improve-doc branch October 5, 2024 12:36
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