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

Correct location of example.db within distro. #83

Open
wants to merge 1 commit into
base: current/blead
Choose a base branch
from

Conversation

jkeenan
Copy link

@jkeenan jkeenan commented Aug 12, 2015

While working my way through QuickStart, at first I could not locate example.db as per documentation.

@ribasushi
Copy link
Collaborator

(reposting as I commented in the wrong box):

Hi!

There is some confusion in the submitted patch. On the very line you edited, your CWD is marked as DBIx-Class/examples/Schema$. Also a bit higher up on line 27 you have an explicit cd ... command.

Could you please harmonize these pieces?
Thanks!

@jkeenan jkeenan closed this Aug 12, 2015
@ribasushi
Copy link
Collaborator

@jkeenan Is... there a reason you closed the PR?

The fact that you ran into difficulties by definitions means the documentation is problematic in its current form (either the cd ... is not visible enough, or something else is amiss). In either case you are in the best position to clarify the existing text, as you have the unique position of knowing what led you astray.

Please, please reconsider fixing things up so that the next person does not fall into the same state of confusion. Note that there is also this very similar piece of documentation, so maybe just linking to it in some way would be sufficient...

I will reopen this issue, at least as a reminder to myself that there is still work to be done here.

Cheers!

@ribasushi ribasushi reopened this Aug 13, 2015
@jkeenan
Copy link
Author

jkeenan commented Aug 13, 2015

I closed the pull request simply because I realized I had misread the documentation.

When I am looking at a CPAN distribution for the first time (after, say, downloading a tarball or doing a git clone), I typically cd to the top-level and conduct all my business from there. So, other things being equal, I would not have done:

$ cd examples/Schema

I would have inspected the database without changing directories:

$ sqlite3 examples/Schema/db/example.db .dump

But that's a matter of taste. I see that, given the series of sub-shell commands you illustrate in the later section, "Resetting the database," cd-ing to examples/Schema ultimately saves keystrokes. But that's not apparent until you get near the end of the document.

Thank you very much.
Jim Keenan

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