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

Update README.md #956

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #956

wants to merge 1 commit into from

Conversation

TopView
Copy link

@TopView TopView commented Aug 9, 2020

Added what a 'gir' is.

Added what a 'gir' is.
@TopView
Copy link
Author

TopView commented Aug 9, 2020

Hope I've got this right.

@@ -1,5 +1,8 @@
# GIR

"[GObject introspection (abbreviated ‘GIR’)](https://developer.gnome.org/programming-guidelines/stable/introspection.html.en) is a system which extracts APIs from C code and produces binary type libraries which can be used by non-C language bindings, and other tools, to introspect or wrap the original C libraries. It uses a system of annotations in documentation comments in the C code to expose extra information about the APIs which is not machine readable from the code itself."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why in quotes?

Suggested change
"[GObject introspection (abbreviated ‘GIR’)](https://developer.gnome.org/programming-guidelines/stable/introspection.html.en) is a system which extracts APIs from C code and produces binary type libraries which can be used by non-C language bindings, and other tools, to introspect or wrap the original C libraries. It uses a system of annotations in documentation comments in the C code to expose extra information about the APIs which is not machine readable from the code itself."
"[GObject introspection (abbreviated ‘GIR’)](https://developer.gnome.org/programming-guidelines/stable/introspection.html.en) is a system which extracts APIs from C code and produces binary type libraries and XML API descriptions which can be used by non-C language bindings, and other tools, to introspect or wrap the original C libraries. It uses a system of annotations in documentation comments in the C code to expose extra information about the APIs which is not machine readable from the code itself."

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The double quotes, are because this is directly quoted from the URL I provided. The single quotes around GIR aren't needed, just my personal preference. Thank you for the additional text. I suppose you might want to include it as '[and XML API descriptions]' (i.e. in square brackets) to show that it's not part of the original quote. OR if you want, just remove the outer double quotes, as it's no longer a direct quote. I don't know the right thing to do here. ....Just that I spend a whole bunch of time trying to figure out what the heck GIR was, so I could even start to read this. .... And while you're at it please clarify the term 'crate', thought I now see it's from the rust packager or something. Thanks again!

@EPashkin
Copy link
Member

While names are same this crate is not GObjectIntrospection, but code generator that used its results.

@TopView
Copy link
Author

TopView commented Aug 10, 2020

@EPashkin, I'm sorry, which names are you referring to? And which crate, and which code generator? And can you say more about what GIR refers to exactly? Thank you for your comment, but unfortunately it left me with more questions and confusion that I started with here. :-)

@EPashkin
Copy link
Member

This crate is code generator

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

Successfully merging this pull request may close these issues.

3 participants