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.

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

Tighten up packbeam_api #10

Merged
merged 1 commit into from
Oct 21, 2023
Merged

Tighten up packbeam_api #10

merged 1 commit into from
Oct 21, 2023

Conversation

fadushin
Copy link
Collaborator

@fadushin fadushin commented Oct 20, 2023 •
edited
Loading

This change set tightens up the packbeam API to expose just enough information about AVM files as is needed without exposing internal implementation details.

Documentation has been written for the API, and we have moved to use ex_doc instead of edoc for documentation generation.

@fadushin fadushin marked this pull request as draft October 20, 2023 01:48
@fadushin fadushin force-pushed the api-cleanup branch 4 times, most recently from fc1caaa to ab63b32 Compare October 21, 2023 17:26
@fadushin fadushin marked this pull request as ready for review October 21, 2023 17:27
UncleGrumpy
UncleGrumpy reviewed Oct 21, 2023
View reviewed changes
Copy link
Collaborator

@UncleGrumpy UncleGrumpy left a comment

Choose a reason for hiding this comment

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

Just one question about the OTP version in README.md. I will test this locally this time before we merge. ;)

README.md Outdated Show resolved Hide resolved
@fadushin
Copy link
Collaborator Author

Just one question about the OTP version in README.md. I will test this locally this time before we merge. ;)

Technically 24 is only needed for ex_doc. But yeah we could test for 22 and not gen the docs there. You should check out the generated docs. Much improved!

@UncleGrumpy
Copy link
Collaborator

Or just add a note that OTP versions 22-23 should work, but are not tested by CI.

@UncleGrumpy
Copy link
Collaborator

Technically 24 is only needed for ex_doc. But yeah we could test for 22 and not gen the docs there. You should check out the generated docs. Much improved!

Yes. We may want to add a section to the main doc site to include a section of edocs for the tools, to accompany the added tools documentation.

UncleGrumpy
UncleGrumpy approved these changes Oct 21, 2023
View reviewed changes
Copy link
Collaborator

@UncleGrumpy UncleGrumpy left a comment

Choose a reason for hiding this comment

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

Looks good. No problems testing locally.

@UncleGrumpy
Copy link
Collaborator

I assume you will be tagging a 0.7.1 with these changes, or soon if you had anything else planned...

@fadushin
Tighten up packbeam_api
5258f57 
This change set tightens up the packbeam API to expose just enough information about AVM files as is needed without exposing internal implementation details.

Documentation has been written for the API, and we have moved to use `ex_doc` instead of `edoc` for documentation generation.

Signed-off-by: Fred Dushin <[email protected]>
@UncleGrumpy
Copy link
Collaborator

Looks great.

@UncleGrumpy UncleGrumpy merged commit 85d3053 into master Oct 21, 2023
6 checks passed
@fadushin fadushin deleted the api-cleanup branch October 21, 2023 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@UncleGrumpy UncleGrumpy UncleGrumpy 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.

None yet
2 participants
@fadushin @UncleGrumpy