-
-
Notifications
You must be signed in to change notification settings - Fork 780
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? #49
Comments
I'm 14 days late but I meant like actual documentation on functions, their signatures, what they do etc. What's in the readme just throws a bunch of examples at you and assumes it shows you what the functions do. |
what I understand, your coding skills are weak. install Visual studio 2017 with Desktop development with C++ . |
I would like to add my 2 cents. I think a good documentation is synonym to allowed more adoption of a technology. It's OK not have enough time to do something better for your interested users, but you can't think too that everyone could have time to debug a project to learn or worst think that your interested users are 'weak' for don't do it. Even if they don't have knowledge enough, the documentation it's for help them, even an advanced user could be helped. I think great if we have more friendly documentation centered to the beginner user perspective, with levels of beginner, intermediate and advanced tutorials for example. Everyone who joys programming, definitely will be thankful, would be great, but if not possible at moment, it's OK too. As open-source project, I hope the community can collaborate one day at this subject Sorry for reopen the thread. Regards for all. |
So, a javascript interpreter and operating systems development is weak? No, I simply did not have the time to sit there reading the code to figure it out, as many people do not feel like doing. |
@RecursiveDescent What are your assumption about GUI ? so that I can suggest better. |
It's more friendly to users by providing APIs and detail func infos. |
right, |
@graysuit documenting the complete API calls is part of a good documentation, and this project has none of this. Sure, it's not mandatory, but you can't expect developers to dive into the source code to find out which functions are available, what they do, the requested parameters, etc. |
I just say politely it looks well documented to me due to:
Documentation also address which function do what and what parameters we should pass... But still I think I'm human and can be wrong as well. |
Dearest Gray Suit, Do you consider documentation to be for weak amateurs!? It is actually the hallmark of professionalism. Documentation on most projects on Github need improvement.
I realize that this issue is closed, but I see this response and attitude demonstrated above as very shockingly counter-productive. |
@vectorselector I respect your opinion. Not sure why I look so harsh. But you didn't read context. I replied to: And about documentation, I know open source/free product will not grab your finger and make you visit all city. Traditionally, C/C++ developers need to figure out by themselves by unit testings and reading internal core. And even it have tons of samples, FAQ...
and again. Don't think this rude or aggressive. |
By fast and would work, at the time I was referring to something easy to get working and simple to setup because I was working in an environment that I couldn't get something as fat as qt to work in, but for the advanced project I was going to use it for just some basic layout wasn't going to do it, and it was faster to just force qt to work than to wade through the header file(or tons of examples in separate repos) making my own map of everything as qt provides good enough documentation. API usage documentation was exactly what I wanted, and for a project with 5.8k stars there was really no reason to still not have it.
Also, autocompletion is not comparable with actual documentation... But that's also another reason why I needed documentation since I was working where I didn't have it in the first place even if I had the knowledge to intuition my way around the autocomplete suggested functions. |
I agree with your 2 points. There's also the issue of a language or build-tool newbie not being a newbie programmer, but perhaps coming from other circles: It also doesn't cost much to add selective informative tips for newbies: Example:
How shall new users of cmake realize the conventions when the documentation emphasizes the total feature set of cmake rather than how most developers use it? We are culture-bearers as well. We are ambassadors of culture. I realize that teaching what a shell is will be out of scope for documentation, but all necessary steps to build and arrive at hello-world or somesuch is what I consider the minimum acceptable documentation. If the API is really only defined in a single header file and is minimal as such, place comments and extract them for at least a minimal API document with function type signatures etc. |
I really want to use this since I can't use Qt or wxWidgets and this looks like it would solve my problems.
However, all I can find are some fairly complicated examples and images of code snippets with almost no context.
The text was updated successfully, but these errors were encountered: