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.

Sign up for GitHub

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

Jump to bottom

Update README.md #956

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

Update README.md #956

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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!



The `GIR` is used to generate both the sys level crate and a safe API crate to use the sys level (FFI) crate.

## How to use
Expand Down