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

Improve format of SendGridHelper docs #611

Merged
merged 3 commits into from Jun 25, 2021

Conversation

mrcasals
Copy link
Contributor

@mrcasals mrcasals commented Jun 14, 2021

This PR iproves the format of the SendGridHelper module docs.

The first paragraph of the function documentation is used as an excerpt that will be shown in the Summary section of the docs page. For example, before this PR:

image

image

I fixed the first example, and simplified the excerpt for the second.

The formatting for the add_personalizations function was broken due to some missing indentation, see before this PR:

image

@mrcasals mrcasals marked this pull request as ready for review June 14, 2021 12:36
@mrcasals mrcasals changed the title Improve format of SendgridHelper docs Improve format of SendGridHelper docs Jun 14, 2021
Copy link
Collaborator

@germsvel germsvel left a comment

Choose a reason for hiding this comment

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

🥳 thanks for these changes!

@germsvel germsvel merged commit 75569aa into beam-community:master Jun 25, 2021
@mrcasals mrcasals deleted the patch-1 branch June 28, 2021 06:53
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.

None yet

2 participants