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

Add a FAQ? #375

Open
jashapiro opened this issue Nov 23, 2020 · 4 comments
Open

Add a FAQ? #375

jashapiro opened this issue Nov 23, 2020 · 4 comments

Comments

@jashapiro
Copy link
Member

Background

While adding #374 , I had the thought that maybe a FAQ for our examples might be worth having.

Problem

We have some opinions about coding style, etc. that might be somewhat unfamiliar to people. In training, we often get questions about things like:

  • "Why do you use :: so much?"
  • "Why do you use read_tsv() instead of read.delim()?"
  • "What if I want to use python?"

Maybe laying some of these out explicitly would be something we could do.
As we test the example pages, more things might come up that might be best addressed by a short FAQ entry than by any major modifications. This would be a nice place to centralize some of these questions.

@cansavvy
Copy link
Contributor

I feel like this is similar but not entirely overlapping with the idea of #117.

@jashapiro
Copy link
Member Author

I feel like this is similar but not entirely overlapping with the idea of #117.

Agreed! I forgot about that one. I guess I would call it an expansion of #117?

@cansavvy
Copy link
Contributor

Right, so I'm not opposed to having both an FAQ and a Glossary type thing, but as we have these ideas currently, they aren't giving much distinct benefit.

But neither has been dove into yet. One idea, is it's possible there's information that would more naturally be covered in an FAQ format as opposed to a Glossary. It could be more specific things that show up in code like what you mention here would be addressed in a Glossary but "bigger picture items would better benefit from a FAQ format.

Not sure at this point.

@cansavvy
Copy link
Contributor

If we do both, they could both probably go in a folder called "appendix" or something.

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