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 clean-up or clarification #195

Open
josherrickson opened this issue Jan 5, 2021 · 1 comment
Open

Documentation clean-up or clarification #195

josherrickson opened this issue Jan 5, 2021 · 1 comment

Comments

@josherrickson
Copy link
Collaborator

A colleague of mine responded to a client email with the advice to run match_on first and pass that to fullmatch. There were no complications on the match that would benefit from this. I asked him how he arrived at that conclusion and he sent the following:

If you ?optmatch, it takes you to the object definition/summary. Then, the fullmatch doc is somewhat overwhelming on first pass. The def of the first argument 'x' refers to match_on, which I went to to simplify how many options were necessary.

Should we re-arrange/clean up the documentation of fullmatch to put the basic use cases (specifically I'm thinking fullmatch.formula) at the front?

@benthestatistician
Copy link
Collaborator

Good idea!

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