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 contains C examples and incorrect descriptions #45

Open
johnperry-math opened this issue Aug 14, 2022 · 0 comments
Open

Comments

@johnperry-math
Copy link

I recently completed my first GtkAda application, and I'm delighted with it, but I had to give up on making sense of the documentation, because:

  • The only examples I've seen in the examples seem to have been retained unchanged from Gtk's C examples. Even someone familiar with C would have difficulty making sense of them, because GtkAda has a different interface than Gtk: many similarly-named functions act differently, and some C functions don't appear in the Ada version, and vice versa.
  • Some functions are documented incorrectly. For instance, the Next function on a Tree_Iter is said to return True or False, but it returns a pointer instead, and the apparent (and apparently undocumented) design is to compare to Null_Iter. (I might be remembering the name wrong.)

It would be OK to submit patches to change this, correct? If so, I'll do this in reference to this issue. I just want to make sure there wasn't a deliberate decision to retain this.

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

1 participant