Skip to content
This repository was archived by the owner on Jun 8, 2021. It is now read-only.

Add doc for FileChooserDialog::with_buttons#39

Merged
GuillaumeGomez merged 1 commit intogtk-rs:masterfrom
EPashkin:add_doc_FileChooserDialog_with_buttons
Dec 3, 2017
Merged

Add doc for FileChooserDialog::with_buttons#39
GuillaumeGomez merged 1 commit intogtk-rs:masterfrom
EPashkin:add_doc_FileChooserDialog_with_buttons

Conversation

@EPashkin
Copy link
Copy Markdown
Member

@EPashkin EPashkin commented Dec 3, 2017

@demurgos
Copy link
Copy Markdown

demurgos commented Dec 3, 2017

Looks good to me

@demurgos
Copy link
Copy Markdown

demurgos commented Dec 3, 2017

I guess that the title could match the default one ("Select a File") but this is pretty minor:

https://github.com/GNOME/gtk/blob/bcc77e169cb0a5219ef5c1f0554b90978ca0d17f/gtk/gtkfilechooserbutton.c#L106

@EPashkin
Copy link
Copy Markdown
Member Author

EPashkin commented Dec 3, 2017

If it match default then IMHO, we can just use None.
So for to be more clear I prefer leave as is.

GuillaumeGomez
GuillaumeGomez reviewed Dec 3, 2017
View reviewed changes
Comment thread gtk/docs.md
the contents of the tooltip for `self`, or `None`
<!-- impl FileChooserDialog::fn with_buttons -->
This function creates a `FileChooserDialog` with buttons:
```no_run
Copy link
Copy Markdown
Member

@GuillaumeGomez GuillaumeGomez Dec 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add an empty line before this one (we'll have rendering issues with the current rustdoc otherwise).

GuillaumeGomez
GuillaumeGomez reviewed Dec 3, 2017
View reviewed changes
Comment thread gtk/docs.md Outdated
This function creates a `FileChooserDialog` with buttons:
```no_run
let dialog = FileChooserDialog::with_buttons::<Window>(
Some("Open File"),
Copy link
Copy Markdown
Member

@GuillaumeGomez GuillaumeGomez Dec 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add two more whitespaces in order to fix the indent for each line please?

@EPashkin EPashkin force-pushed the add_doc_FileChooserDialog_with_buttons branch from eff31e9 to 49f9699 Compare December 3, 2017 11:43
@EPashkin
Copy link
Copy Markdown
Member Author

EPashkin commented Dec 3, 2017

Fixed

@GuillaumeGomez
Copy link
Copy Markdown
Member

GuillaumeGomez commented Dec 3, 2017

Thanks!

@GuillaumeGomez GuillaumeGomez merged commit 1f1f322 into gtk-rs:master Dec 3, 2017
@EPashkin EPashkin deleted the add_doc_FileChooserDialog_with_buttons branch December 3, 2017 11:51
@demurgos
Copy link
Copy Markdown

demurgos commented Dec 7, 2017

It seems that this commit broke CI for gtk-rs because the code sample is just a an example with the most relevant part to get an idea how to use the function (it does not import all the symbols). This code seems to be executed by CI anyway: https://travis-ci.org/gtk-rs/gtk/builds/312908554?utm_source=github_status

@EPashkin
Copy link
Copy Markdown
Member Author

EPashkin commented Dec 7, 2017

Yes, I used wrong code: no_run instead ignore

@EPashkin EPashkin mentioned this pull request Dec 7, 2017
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@GuillaumeGomez GuillaumeGomez GuillaumeGomez left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@EPashkin @demurgos @GuillaumeGomez