Updated documentation to be more explicit about search path settings and lookup #23

Merged
merged 1 commit into from Sep 16, 2011

Conversation

Projects
None yet
3 participants
@nek4life
Contributor

nek4life commented Sep 14, 2011

Based on some issues that were raised on irc I've updated the documentation to what I hope more accurately portrays what is happening when the lookup path is and isn't set.

A bit long but here is the tail end of the conversation that initiated these changes to the documentation.

http://irclogs.rulim.de/%23pyramid/%23pyramid.2011-09-14.log.html#t2011-09-14T02:42:29

@dhaaker

This comment has been minimized.

Show comment Hide comment
@dhaaker

dhaaker Sep 14, 2011

Wouldn't it clearer to move this (adding template dir to searchpath) in a separate paragraph? The way you put it, you give the impression that it is mandatory, which is not the case.

Wouldn't it clearer to move this (adding template dir to searchpath) in a separate paragraph? The way you put it, you give the impression that it is mandatory, which is not the case.

This comment has been minimized.

Show comment Hide comment
@nek4life

nek4life Sep 14, 2011

Owner

The impetus for this is that lot's of people miss this step (configuring the search path) and want it configured to look under a /templates folder. All the pyramid scaffolds come with a /templates folder as well so I think they come to expect Jinja2 to magically look in there. I added the warning about not configuring it, although what I really wanted was an info block callout instead but couldn't find one (I do not know rst well). In my mind I would consider setting the search path part of the setup, however it may be more appropriate under usage. At any rate I think however it is written it should be more prominent than it is in the current set of instructions. I suppose another alternative could be to put the heading Optional or Optional Setup above that section.

Owner

nek4life replied Sep 14, 2011

The impetus for this is that lot's of people miss this step (configuring the search path) and want it configured to look under a /templates folder. All the pyramid scaffolds come with a /templates folder as well so I think they come to expect Jinja2 to magically look in there. I added the warning about not configuring it, although what I really wanted was an info block callout instead but couldn't find one (I do not know rst well). In my mind I would consider setting the search path part of the setup, however it may be more appropriate under usage. At any rate I think however it is written it should be more prominent than it is in the current set of instructions. I suppose another alternative could be to put the heading Optional or Optional Setup above that section.

rockyburt added a commit that referenced this pull request Sep 16, 2011

Merge pull request #23 from nek4life/master
Updated documentation to be more explicit about search path settings and lookup

@rockyburt rockyburt merged commit 110242f into Pylons:master Sep 16, 2011

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment