PerlDancer / PerlDancer/Dancer2
Serialization documentation should point more clearly to 'send_as' for routes (templates) that may need them.
Nobody has claimed this yet.
- Dominant language
- Perl
- Stars
- 604
- Forks
- 288
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 5
Description
Dancer1 allowed you to mix templates and serialized output fairly seamlessly.
Upgrading to Dancer2, where serialization is applied globally, breaks this templating expectation. While a couple of solutions are suggested, none are so easy as simply using 'send_as' for the minority of either templated or serialized routes, and setting the serializer on or off as appropriate for the majority.
Please mention 'send_as' more prominently in the migration guide and the cookbook when explaining the global nature of serialization, as a way to perform one-offs from whichever global default is chosen.
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
Search the migration guide and cookbook for the explanation of global serialization and the existing send_as documentation. Update both places to point more prominently to send_as for routes that need one-off templated or serialized output, then verify that the global-default and exception guidance is clear.
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
- Clearly specified
- Newbie friendliness
- 45/100