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

Improve documentation #45

Open
akesterson opened this issue Oct 11, 2015 · 3 comments
Open

Improve documentation #45

akesterson opened this issue Oct 11, 2015 · 3 comments
Labels

Comments

@akesterson
Copy link
Collaborator

There have been several emails and bugs filed about dpath's documentation. Apparently there are several users who find it confusing, and even the maintainers have found the documentation frustrating at times.

Let's please link all documentation-related incidents here, so we can get them all knocked out at once.

@akesterson
Copy link
Collaborator Author

Some of these updates are bugs in the docs, some are enhancements, labeling as both bug and enhancement.

@abarnert
Copy link

Note that in #15 the answer incorrectly says [a..z] when it should say [a-z], and also doesn't get across that the rules are actually pretty complicated (consider what [] or []a] mean). So, I think making it very clear that they mean what fnmatch mean is pretty important. (The alternative would be to full document fnmatch syntax—which is especially fun given that there have been a couple of minor changes from 2.6 to 3.7 that you'd have to document.)

Also #80 probably requires a doc change whether it's fixed or not. Obviously replacing fnmatch with not-quite-fnmatch means you can no longer just defer to it for documentation. But leaving it alone means you probably need to at least document the fnmatch way of escaping (with a single-character glob class), and maybe point out why it can't be used for separators.

@akesterson
Copy link
Collaborator Author

Blocked by #136

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