Skip to content

Add typespecs for public functions #86

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 11 commits into from
Sep 11, 2024
Merged

Add typespecs for public functions #86

merged 11 commits into from
Sep 11, 2024

Conversation

MSE99
Copy link
Contributor

@MSE99 MSE99 commented Sep 8, 2024 •
edited
Loading

This PR adds type specs to public functions as requested

Closes #84

crbelaus
crbelaus requested changes Sep 9, 2024
View reviewed changes
Copy link
Contributor

@crbelaus crbelaus left a comment

Choose a reason for hiding this comment

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

Unfortunately this is still throwing warnings during doc generation.

@MSE99
Copy link
Contributor Author

MSE99 commented Sep 9, 2024

Hello, i updated the code with the changes you requested can you please check it again to see if anything else needs to be done.

@MSE99 MSE99 requested a review from crbelaus September 9, 2024 16:21
crbelaus
crbelaus requested changes Sep 10, 2024
View reviewed changes
Copy link
Contributor

@crbelaus crbelaus left a comment

Choose a reason for hiding this comment

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

This still needs changes.

@MSE99
Copy link
Contributor Author

MSE99 commented Sep 10, 2024

I pushed an update with the required changes, everything good now?

@MSE99 MSE99 requested a review from crbelaus September 10, 2024 15:16
crbelaus
crbelaus requested changes Sep 11, 2024
View reviewed changes
Copy link
Contributor

@crbelaus crbelaus left a comment

Choose a reason for hiding this comment

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

This is coming along nicely. We just need to document the exception type and put it along the existing context type.

Also the report/3 function spec is not showing in the generated docs because it is missing the third parameter.

@crbelaus crbelaus changed the title Add typespecs Add typespecs for public functions Sep 11, 2024
@MSE99 MSE99 requested a review from crbelaus September 11, 2024 14:26
crbelaus
crbelaus approved these changes Sep 11, 2024
View reviewed changes
Copy link
Contributor

@crbelaus crbelaus left a comment

Choose a reason for hiding this comment

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

Thanks @MSE99 !

@crbelaus crbelaus merged commit f3e175f into elixir-error-tracker:main Sep 11, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crbelaus crbelaus crbelaus approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add typespecs for public functions
2 participants
@MSE99 @crbelaus