Add BookmarkList example
#1347
Add BookmarkList example
#1347
Conversation
|
I was expecting a proper example in https://github.com/gtk-rs/gtk4-rs/tree/master/examples instead |
|
Oh yeah, that is a good idea too! I was thinking of having a example section in the docblock to sit shows in the documentation and when using the "Go to definition" in the IDE. Does this project accept examples in the docblock too? |
gtk4/src/bookmark_list.rs
Outdated
| /// To iterate over `BookmarkList` call `iter::<gio::FileInfo>` to get an iterator. | ||
| /// ```no_run | ||
| /// let bookmarks = gtk::BookmarkList::new(Some("bookmarks.xbel"), None); | ||
| /// for bookmark in bookmarks.iter::<gio::FileInfo>() { |
There was a problem hiding this comment.
This example looks weird to rust ppl I think.
Would it better to use
while let Some(Ok(bookmark)) = bookmarks.iter::<gio::FileInfo>().next() {
// ...
}There was a problem hiding this comment.
@bilelmoussaoui What do you think?
There was a problem hiding this comment.
I agree with what @zekefast said. Although, does this example shows in the docs?
There was a problem hiding this comment.
Okay I updated the PR with the example provided by @zekefast. I am not sure, but it should show up when you press F12 in VS Code.
There was a problem hiding this comment.
You would have to resolve merge conflicts, the PR as is can't be tested by the CI nor merged
|
Please test locally first.... |
Add example for #1346.