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

Page object summary() documentation clarification #236

Closed
karlding opened this issue Feb 22, 2016 · 1 comment
Closed

Page object summary() documentation clarification #236

karlding opened this issue Feb 22, 2016 · 1 comment

Comments

@karlding
Copy link
Contributor

The documentation is a little misleading with regards to summary().

This returns a truncated or shortened version of your content. You can provide an optional 
size parameter to specify the number of words. Alternatively, if no size is provided, the 
value can be obtained via the site-wide variable summary.size from your site.yaml configuration.

However, summary(size) limits by the number of characters, not the number of words, which is evident in system/src/Grav/Common/Page/Page.php.

Should the documentation be updated to clarify that it is the number of characters that're being limited, and not the words? Or is this an oversight and summaries were intended to be based on the number of words?

@rhukster
Copy link
Member

Thanks, closing this now.

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

No branches or pull requests

2 participants