search

wmww / gtk-layer-shell

A library to create panels and other desktop components for Wayland using the Layer Shell protocol
GNU General Public License v3.0
318 stars 16 forks source link

Fix documentation to refer to variants #125

Closed pentamassiv closed 2 years ago

pentamassiv commented 2 years ago

Thank you for writing gtk-layer-shell! I am updating and cleaning the Rust wrapper, which I automatically created using gir. I now added documentation but when I generate it, I get two warnings described in issue 2 of the repo.

I suggest to use % instead of # in the docs to show that it is a reference to a variant of an enum and not it's own type. This gets rid of the warning and at least the Rust docs don't seem to change from it. If I read this comment correctly, the warning and the proposed changes make sense.

By opening this pull request, I agree for my modifications to be licensed under whatever licenses are indicated at the start of the files I modified

wmww commented 2 years ago

I should really link https://github.com/pentamassiv/gtk-layer-shell-gir and/or https://crates.io/crates/gtk-layer-shell/ from the README so they're move discoverable. Would any/all of your work make sense to upstream? I already include a Vala standalone project in the examples, which I build as part of the tests. Would it also make sense to include a Rust one?

wmww commented 2 years ago

Also, your repo name is "*-gir". Other progreamming languages use GIR too, right? Is that an indication your project is more widely applicable than just Rust?

wmww commented 2 years ago

Oops, I pushed this instead of PRing it. Does it look good to you? 2aba3c994584338723afd4ad803c0548c0d31700

wmww commented 2 years ago

(I'm now thinking it makes sense for your repo to be separate and for it to hold the Rust examples as it currently does, but open to suggestions)

pentamassiv commented 2 years ago

Thank you for the fast review & merge.

Thank you for linking to my repo. Originally I created the bindings because I needed them for my project and I overlooked that there already was a repo on Github. Maintaining the bindings should be fairly easy since they are automatically generated. There are a few issues that I'd like to iron out but after that, maintaining it should not consume much time at all. I am open to move the repo somewhere upstream, but I am not sure where it would fit best. I guess for now we can leave it where it is and if somebody finds a better place, just let me know about it :)