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

An inconsistency between docs and the code #17

Closed
mrfatguy opened this issue Jan 16, 2015 · 4 comments
Closed

An inconsistency between docs and the code #17

mrfatguy opened this issue Jan 16, 2015 · 4 comments

Comments

@mrfatguy
Copy link

There's an inconsistency between what you write in docs (README.md) and what you actually have in latest version of your code (tested on version 0.8.12 released on 11 Apr 2014):

  1. Docs says about yiic database command, while it actually is yiic edatabase due to naming scheme you used in your code. One must rename EDatabaseCommand class to DatabaseCommand to fix this or use yiic edatabase command instead.
  2. Running command without any parameters (i.e. yiic edatabase) does display help, but also throws Error: Unknown action: index error. You may want to mute that somehow.

For people, who are using yiic commands for the first time, it would be a great addition to extend installation part of your doc as well. Two-line paragraph mentioning, that contents of zip file should be placed in protected/commands (which must be created, if does not exist) and that it must be placed without folder structure (just, as is, including views folder), which is contrary to extensions for example, which can be placed in subfolders, etc. That would help a lot to newbies, like me.

Aside above, thank you very much for a wonderful extension, which saves hours of coding!

@schmunk42
Copy link
Owner

Thanks for your feedback, I'll review it - PRs are also always highly welcome.
Did you manually install the extension - not via composer?

@mrfatguy
Copy link
Author

I didn't make a PR, because I don't know, which version you prefer -- edatabase or database -- and therefore, whether my PR should fix documentation or code?

Yes, manually. I don't know and I don't use composer. Later, I have manually altered my local version to have DatabaseCommand and use yiic database.

@schmunk42
Copy link
Owner

I created another issue for the broken action.

What's about moving this section more up and add the custom path info there, eg "replace vendor.schmunk42 ...."?
With the config setting you can run it with yiic database also.

@mrfatguy
Copy link
Author

You're absolutely right. This section is way to far. So far, that I didn't even read it. With this information on top (actually, merged into "Installation" section IMHO) everything can be solved nice and easily.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants