-
-
Notifications
You must be signed in to change notification settings - Fork 11k
DOC: Should we create an FAQ (or see if we already have a place) #27871
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
Comments
A FAQ seems like a not so good idea. FAQs almost always are quite incomplete and go out of date over time. We used to have one a long time ago IIRC, and it was exactly like that - a random grab bag of stuff with mostly outdated specific problems. For topics like threading and numerical precision, it'd be great to have good docs pages, that will be quite valuable. That still solves the problem at hand here (you can link to the relevant page) without starting a FAQ. |
Note that there is already https://numpy.org/devdocs/user/troubleshooting-importerror.html, which has already started degrading, a number of entries haven't been relevant in quite a while. |
+1 For the idea. I can get started working on this if help is wanted. |
Instead of an FAQ, adding a couple pages to the "Advanced usage and interoperability" section of the main ToCtree or to the https://numpy.org/devdocs/dev/underthehood.html section sounds like a good idea. I think the best strategy would be for someone to have a chat with @seberg and pick his brain on the main things to mention - maybe at a docs meeting? |
@melissawm The "Advanced usage and interoperability" section sounds like a good idea, but please can you shortly summarize what the discussion here is about? I want to contribute and think about it. |
There are a few pitfalls that come up more than others:
We had discussed this once in the triage meeting, because these keep coming up every now and then. It might not help much for users, but may just be helpful to have an easy link available on issues.
Please feel free to edit or comment other things. More than two things may be good if we have a FAQ.
The text was updated successfully, but these errors were encountered: