Skip to content

[Docs]: Explain “tracker ID” and other attributes #946

Description

@kpreid

Location

https://docs.rs/notify/8.2.0/notify/event/struct.EventAttributes.html

What's the issue?

The documentation for EventAttributes mentions

pub fn tracker(&self) -> Option<usize>
Retrieves the tracker ID for an event directly, if present.

But it doesn’t explain what a “tracker ID” is, and this is not mentioned elsewhere in the documentation as far as I have seen. What can I do with this number?

Similarly, “info” and “source” are not explained. The names give some hint about their goal but there is no information about what I might expect to find there.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions