silverstripe / silverstripe/developer-docs
Docs: Info about how to debug a variable in the template is missing
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 7
- Forks
- 74
- Avg merge
- 1d 14m
- Merged PRs (30d)
- 6
Description
Affected Version
Current docs
Description
I wasn't able to find information how to debug a variable while trying to help a newbe on slack:
Q: I am new with SilverStripe and I want to know if exists equivalent of print_r or var_dump inside SilverStripe template
A:
$Foo.Debugshows the value of$Foo. Indside a loop you can call$Me.Debugto get the current variable in the loop
At which document do you think we should insert information about how to debug variables in templates? Would https://docs.silverstripe.org/en/4/developer_guides/debugging/template_debugging/ be good or should it go to the templates section, e.g. https://docs.silverstripe.org/en/4/developer_guides/templates/common_variables/ ?
Steps to Reproduce
Search docs ;)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the existing template debugging page with the templates common variables page linked in the issue. Confirm where guidance for $Foo.Debug and $Me.Debug fits best, then add the explanation and make sure it is discoverable when searching the documentation for debugging template variables.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100