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

chore(README): Format local/system parameters as table #211

Merged
merged 1 commit into from
Oct 17, 2023

Conversation

guicamest
Copy link
Contributor

Description of changes:

This PR formats local and system parameters in the README as a table, in order to improve reading

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@guicamest
Copy link
Contributor Author

guicamest commented Oct 5, 2023

I think it can even be written as

parameter type description
aws.region local/system specifies the default region for API calls
.. ..
s3.spi.endpoint local the endpoint to use to access the bucket; this is extracted from the uri by the S3X provider
.. ..

Might be easier to maintain / read since there is less text. What do you think?

Copy link
Contributor

@markjschreiber markjschreiber left a comment

Choose a reason for hiding this comment

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

Thanks!

@markjschreiber markjschreiber merged commit 9406f59 into awslabs:main Oct 17, 2023
1 check passed
@guicamest guicamest deleted the readme-parameters-table branch October 19, 2023 08:37
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