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 example keys for 'input' to docs for post_service generated files #106

Closed
wants to merge 3 commits into from

Conversation

onno-vos-dev
Copy link
Member

An initial stab to at least improve the quality of life that was proposed in: #87

I've tried to do the same as in the above PR but as stated in it's description, it takes FOREVER to compile aws-elixir with such a proposed change. So at least, let's add some example keys in the docs to start with which should be a step in the right direction until we figure out how to better deal with this.

Example diff in rds.ex:

   @doc """
   Applies a pending maintenance action to a resource (for example, to a DB
   instance).

  Example keys for input map:
  ApplyAction Required: true
  OptInType Required: true
  ResourceIdentifier Required: true

  """
  def apply_pending_maintenance_action(%Client{} = client, input, options \\ []) do

Example diff in aws_rds.erl:

%% @doc Applies a pending maintenance action to a resource (for example, to a
%% DB instance).
%%
%% Example keys for input map:
%% ApplyAction Required: true
%% OptInType Required: true
%% ResourceIdentifier Required: true

apply_pending_maintenance_action(Client, Input)

@onno-vos-dev
Copy link
Member Author

Perhaps we can generate more rich @spec instead? I'll try tonight 👍 (Suggested by @Gmora08)

@onno-vos-dev onno-vos-dev force-pushed the add-example-input-to-doc-strings branch from a6587cb to 602a877 Compare March 12, 2024 18:16
@onno-vos-dev
Copy link
Member Author

Will try and generate types instead 👍

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.

1 participant