Skip to content
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

documentation suggestion #27

Closed
dadaphl opened this issue Jun 11, 2015 · 2 comments
Closed

documentation suggestion #27

dadaphl opened this issue Jun 11, 2015 · 2 comments
Assignees
Labels

Comments

@dadaphl
Copy link

dadaphl commented Jun 11, 2015

gulp.src('*/.svg', {cwd: 'assets'})

is misleading for a gulp beginner. I thought the cwd:'assets' part is some kind of configuration option. It took me a while to figure out, that that was the reason my images weren't found.
Also the, there is no output from gulp that indicates what it is doing. Hard locate mistakes.

@jkphl jkphl added the question label Jun 12, 2015
@jkphl jkphl self-assigned this Jun 12, 2015
@jkphl
Copy link
Collaborator

jkphl commented Jun 12, 2015

Hey @dadaphl,

thanks for reporting this. Although I understand your concerns — especially because I'm a Gulp beginner myself — I don't really know how to deal with it. What do you suggest?

The line

gulp.src('*/.svg', {cwd: 'assets'})

strictly isn't part of gulp-svg-sprite at all. I think it's beyond gulp-svg-sprite's scope to explain the way of globbing in gulp — that knowledge should be seen as a pre-requisite. IMO it's rather important to showcase that there is the cwd option for gulp.src(), as omitting it in the documentation would surely provoke another documentation suggestion ...

Do you think changing "assets" to "path/to/assets" and / or adding a hint to Gulp's globbing options would improve the situation?

Thanks & cheers,
Joschi

jkphl added a commit that referenced this issue Jun 24, 2015
@jkphl
Copy link
Collaborator

jkphl commented Jun 24, 2015

As you didn't feedback anymore, I modified the documentation as suggested and will close this issue now. Please feel free to re-open it in case of further problems.

@jkphl jkphl closed this as completed Jun 24, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants