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

Add typedocs for @type t types #551

Merged
merged 6 commits into from May 11, 2023
Merged

Add typedocs for @type t types #551

merged 6 commits into from May 11, 2023

Conversation

varsill
Copy link
Contributor

@varsill varsill commented May 8, 2023

No description provided.

@varsill varsill added the no-changelog This label has to be added if changes from the PR are not meant to be placed in the CHANGELOG.md label May 8, 2023
@varsill varsill marked this pull request as ready for review May 8, 2023 12:57
@varsill varsill requested a review from mat-hek as a code owner May 8, 2023 12:57
@@ -16,6 +16,9 @@ defmodule Membrane.Time do
@compile {:inline,
native_units: 1, native_unit: 0, nanoseconds: 1, nanosecond: 0, second: 0, seconds: 1}

@typedoc """
The time represented in Membrane's native time units - nanoseconds.
Copy link
Member

Choose a reason for hiding this comment

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

the underlying unit technically shouldn't be relied on

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've removed the note that it's using nanoseconds

lib/membrane/time.ex Outdated Show resolved Hide resolved
Co-authored-by: Mateusz Front <mateusz.front@swmansion.com>
@varsill varsill merged commit 5b334db into master May 11, 2023
7 checks passed
@varsill varsill deleted the move_t_docs_to_typedocs branch May 11, 2023 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog This label has to be added if changes from the PR are not meant to be placed in the CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants