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

Missing ":site, :post_render" payload documentation on site #5280

Merged
merged 2 commits into from Aug 30, 2016

Conversation

Projects
None yet
5 participants
@Anthony-Gaudino
Contributor

Anthony-Gaudino commented Aug 24, 2016

The hook :site, :post_render provides a payload, but the plugins documentation section of the official Jekyll website doesn't inform this.

The hook ":site, :post_render" also provides a "payload", but the plu…
…gins documentation section of the official Jekyll site doesnt inform this.

@Anthony-Gaudino Anthony-Gaudino changed the title from Missing `:site, :post_render` payload documentation on site to Missing ":site, :post_render" payload documentation on site Aug 24, 2016

Show outdated Hide outdated site/_docs/plugins.md
case of <code>:pre_render</code> and <code>:site, :post_render</code>, your hook
will also receive a payload hash as a second parameter which allows you full
control over the variables that are available while rendering in the former case
and make final changes just before writing your website to disk on the latter

This comment has been minimized.

@parkr

parkr Aug 27, 2016

Member

former/latter is kind of confusing here. Could you split this big sentence starting with But... into multiple? Perhaps:

However, in the case of :pre_render and :post_render, your hook will also receive a payload hash as a second parameter. In the case of :pre_render this payload gives you full control over the variables that are available while rendering. In the case of :post_render, the payload contains final values after rendering of your content is complete (useful for sitemaps, feeds, etc).

@parkr

parkr Aug 27, 2016

Member

former/latter is kind of confusing here. Could you split this big sentence starting with But... into multiple? Perhaps:

However, in the case of :pre_render and :post_render, your hook will also receive a payload hash as a second parameter. In the case of :pre_render this payload gives you full control over the variables that are available while rendering. In the case of :post_render, the payload contains final values after rendering of your content is complete (useful for sitemaps, feeds, etc).

@Anthony-Gaudino

This comment has been minimized.

Show comment
Hide comment
@Anthony-Gaudino

Anthony-Gaudino Aug 28, 2016

Contributor

@parkr, the text has been updated as you suggested.

I did some changes to your text because my tests showed that not all :post_render hooks provide a payload, only the :site, :post_render hook does.

Contributor

Anthony-Gaudino commented Aug 28, 2016

@parkr, the text has been updated as you suggested.

I did some changes to your text because my tests showed that not all :post_render hooks provide a payload, only the :site, :post_render hook does.

@DirtyF

This comment has been minimized.

Show comment
Hide comment
@DirtyF

DirtyF Aug 30, 2016

Member

LGTM

Member

DirtyF commented Aug 30, 2016

LGTM

@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Aug 30, 2016

Contributor

LGTM.

Contributor

envygeeks commented Aug 30, 2016

LGTM.

@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Aug 30, 2016

Contributor

@jekyllbot: merge +site

Contributor

envygeeks commented Aug 30, 2016

@jekyllbot: merge +site

@jekyllbot jekyllbot merged commit 0ad9fa3 into jekyll:master Aug 30, 2016

1 of 3 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
jekyll/lgtm Approved by @envygeeks. Requires 1 more LGTM.
continuous-integration/travis-ci/pr The Travis CI build passed
Details

jekyllbot added a commit that referenced this pull request Aug 30, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment