Skip to content

docs: fix parameter names left from the nautilus era - #3832

Merged
mtwebster merged 2 commits into
linuxmint:masterfrom
darkdi:nautilus-era-doc-names
Sep 8, 2026
Merged

docs: fix parameter names left from the nautilus era#3832
mtwebster merged 2 commits into
linuxmint:masterfrom
darkdi:nautilus-era-doc-names

Conversation

@darkdi

@darkdi darkdi commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

These names date back to nautilus: nemo_mime_activate_file still documents @view and @use_new_window, which became parent_window and flags when the window slot work landed, and nemo_launch_application documents @uris although it takes a list of files and builds the uris itself. I left the block above nemo_launch_application_from_command_array alone, since it names the non-array function and moving it is a judgement call.

Comment thread src/nemo-mime-actions.c Outdated
* with a component. This is normally called only by subclasses.
* @view: FMDirectoryView in question.
* @parent_window: The window to parent dialogs on.
* @files: A GList of NemoFiles to activate.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This doesn't really 'fix' anything - all arguments should be listed...

parent_window
files
launch_directory
flags
user_confirmation

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added documentation for every parameter, including slot, in signature order in eee6903. Also moved the parameter descriptions before the function description.

Comment thread src/nemo-mime-actions.c Outdated
Comment on lines +2317 to +2321
* Activate a file in this view. This might involve switching the displayed
* location for the current window, or launching an application.
* @view: FMDirectoryView in question.
* @parent_window: The window to parent dialogs on.
* @file: A NemoFile representing the file in this view to activate.
* @use_new_window: Should this item be opened in a new window?
* @flags: How the location should be opened.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

same

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated this function too in eee6903: all five parameters are documented. Verified that both parameter lists match the signatures and that executable code is unchanged.

Signed-off-by: Dmitry Rantovov <rantovov5@gmail.com>
@mtwebster
mtwebster merged commit 678474c into linuxmint:master Sep 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants