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.

Sign up for GitHub

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

Jump to bottom

Generated RoboFile lacks PHPDoc #43

Closed
Rarst opened this issue Jun 12, 2014 · 1 comment
Closed

Generated RoboFile lacks PHPDoc #43

Rarst opened this issue Jun 12, 2014 · 1 comment

Comments

@Rarst
Copy link
Contributor

Rarst commented Jun 12, 2014

Generated RoboFile.php lacks PHPDoc for the class.

  1. That makes IDE scream at you for being shoddy about it. :)
  2. Having short default explanation and link to Robo home page would probably be helpful for people encountering it for the first time.

I took a quick look at implementation for maybe pull requesting something in, but since class file/name are implemented as class constants (for flexibility I assume?) I am not sure what would be the way to go with adding PHPDoc to it.
@DavertMik
Copy link
Member

Sure you can send a Pull Request. RoboFile is generated inside Runner.php
I think some additional comments on using this file as well as link to site should be added as you proposed. Nice idea.

Rarst added a commit to Rarst/Robo that referenced this issue Jun 13, 2014
@Rarst
Added PHPDoc to RoboFile template, fixes consolidation#43
900d4a3
@Rarst Rarst mentioned this issue Jun 13, 2014
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@DavertMik @Rarst