Skip to content

[BestPractices Removing micro-optimization note about @Template #4464

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

Closed
wants to merge 1 commit into from

Conversation

weaverryan
Copy link
Member

Q A
Doc fix? no
New docs? no
Applies to 2.3+
Fixed tickets -

Hi guys!

I think that a small performance gain is not a great reason to recommend something. And really, this was not the most important reason for recommending against @Template. I think it's clearer to focus on the real reason, and not get into performance (we could argue against using any feature because of performance).

Thanks!

@javiereguiluz
Copy link
Member

One of the (few) great things about @Template() is that it takes into account the format of the request to determine the template to render. Should we add a note about this or is not that important?

@@ -76,20 +76,15 @@ Template Configuration
Don't use the ``@Template()`` annotation to configure the template used by
the controller.

The ``@Template`` annotation is useful, but also involves some magic. For
that reason, we don't recommend using it.
The ``@Template`` annotation is useful, but also involves some magic. We
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You avoided the first person perspective in the rest of the Best Practices, didn't you?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, this is one spot where we use it liberally - as in "we recommend..."

@weaverryan
Copy link
Member Author

@javiereguiluz I've never understood the point of the guessing of the template suffix, but it sounds like you may have a use-case. For me, I would never use a template to print JSON or XML, so I've never found this useful. Is there some good case for this?

@wouterj
Copy link
Member

wouterj commented Feb 19, 2015

ping

@xabbuh xabbuh deleted the best-practices-no-micro-optimization branch March 16, 2015 06:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants