Skip to content

Some more documentation

Federico Mena Quintero requested to merge (removed):docs into master

I added #![warn(missing_docs)] here and there and started going at it.

There are a lot of these:

warning: missing documentation for a method
  --> zbus/src/fdo.rs:77:1
   |
77 | #[dbus_proxy(interface = "org.freedesktop.DBus.Debug.Stats")]
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: this warning originates in an attribute macro (in Nightly builds, run with -Z macro-backtrace for more info)

But I haven't checked to what it refers yet.

Question: should zbus_polkit::policykit1::Authority be a public trait? It's the only thing that can return the (public) TemporaryAuthorization.

Another question: zbus_polkit just exports the public module policykit1, plus the errors. Is that module deliberately not pub use policykit1::* in case a policykit2 gets added later? (I'm trying to figure this out to include module-level docs for the policykit1 module)

Merge request reports