Generate types and type specs for all generated functions in aws-elixir and aws-erlang #109
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Mar 16, 2024
philss
approved these changes
Mar 22, 2024
Contributor
philss
left a comment
philss
left a comment
There was a problem hiding this comment.
Awesome work, @onno-vos-dev!! 🎉 ❤️
I liked very much the way it is describing the type! I hope in the future we can include the entire type description in the type specs.
I added some minor points only, but consider it approved! 😺
Please don't forget to run the formatter :)
…ir and aws-erlang - Generate common errors in order to unify types and reduce noise - Ensure that for Elixir, typedoc examples are considered code blocks - Erlang Type docs are not hoverable for now due to issues with 'rebar3 ex_doc' - Will follow up on this task - Increase Task.await/2 timeout
onno-vos-dev
force-pushed
the
generate-types-and-type-specs-for-all-generated-code
branch
from
0faf06b to
70fdc8e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Generate types and type specs for all generated functions in aws-elixir and aws-erlang
Follow up tasks
Tasks to follow up on:
aws_client()inaws-erlangis marked asopaquebut this is not really true due tobuild_host/2. We should either fix this to be trulyopaqueor simply turn it into a regulartype.aws-erlangand while getting it down to 0 is likely gonna be a challenge, solving the above bring it down to 27 which is a lot more reasonable.nowarn_unused_typetorebar.configinaws-erlangsince some types are only used from comments (examples) and hence are "unused". Let's not flood the terminal with noise.Generated code
Generated aws-elixir code as an example: comparison
Generated aws-erlang code as an example: comparison
Additional info
Related to #108 which I declined in favor of this one due to wrong branch naming.
Some additional screenshots
ElixirLS overview
Erlang types overview