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

Improvements to erlang docs #102

Merged
merged 3 commits into from
Feb 28, 2024
Merged

Conversation

onno-vos-dev
Copy link
Member

@onno-vos-dev onno-vos-dev commented Feb 28, 2024

  • Ensure <code> tags that contain references to AWS SDK GO functions are ignored as they blow up ex_doc
  • Improve links and ensure more links are rendered in the docs

Example OLD:

%% To verify that all parts have been removed and prevent getting charged for
%% the part storage, you should call the ListParts API operation and ensure
%% that the parts list is empty.

Example NEW:

%% To verify that all parts have been removed and prevent getting charged for
%% the part storage, you should call the ListParts:
%% https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html API
%% operation and ensure that the parts list is empty.

@onno-vos-dev
Copy link
Member Author

onno-vos-dev commented Feb 28, 2024

Merging considering we've had two aws-erlang releases with no docs on hex.pm and I'd like to fix that right away

@onno-vos-dev onno-vos-dev merged commit 1eab233 into master Feb 28, 2024
3 checks passed
@jadeallenx
Copy link
Contributor

Thank you for fixing this

@onno-vos-dev
Copy link
Member Author

@jadeallenx While it fixed the failure to generate docs, aws-erlang generates so much docs hex.pm refuses to accept the tarball we send it 🤦‍♂️ I'll look at that tomorrow and see what to do about that 👌

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.

2 participants