PerlDancer / PerlDancer/Dancer2-Plugin-Auth-Extensible
Document template-accessible vars.logged_in_user_hash or session.logged_in_user[_realm]?
Nobody has claimed this yet.
- Dominant language
- Perl
- Stars
- 10
- Forks
- 21
- PR merge metrics
- No merged PRs in 30d
Description
I am learning Dancer2 and find this module quite useful! I see that logged-in-user information is available in a TT2 template through vars and session. For example, both of these work:
[% if vars.logged_in_user_hash %]
<p>(Hash) You are logged in as
[% vars.logged_in_user_hash.name | html %]</p>
[% end %]
[% if session.logged_in_user %]
<p>(Session) You are logged in as
[% session.logged_in_user | html %]@[% session.logged_in_user_realm | html %]</p>
[% end %]
However, I do not see vars.logged_in_user_hash or session.logged_in{_user,_user_realm} documented in the POD for this module. Is any of those part of the public API of this module? If so, could they be documented? Thanks for considering this question!
Contributor guide
No contributing guide indexed for this repository
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
Start by reading the module's POD and tracing where vars.logged_in_user_hash and session.logged_in_user/session.logged_in_user_realm are exposed. Confirm which values are part of the public API, then document the supported template variables or clarify their status in the module documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- perl
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100