Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing documentation for x11utils #8676

Merged
merged 1 commit into from
Oct 15, 2019

Conversation

DrMullings
Copy link
Contributor

Now every function is documented

@DrMullings
Copy link
Contributor Author

@SergioAtSUSE @asdil12

lib/x11utils.pm Outdated

ensure_fullscreen($tag);

tag can contain a needle name and is optional, it defaults to yast2-windowborder
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
tag can contain a needle name and is optional, it defaults to yast2-windowborder
C<$tag> can contain a needle name and is optional, it defaults to yast2-windowborder

lib/x11utils.pm Outdated

handle_relogin();

First logs out and the log in via C<handle_logout> and C<handle_login>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
First logs out and the log in via C<handle_logout> and C<handle_login>
First logs out and the log in via C<handle_logout()> and C<handle_login()>

lib/x11utils.pm Outdated

select_user_gnome($myuser);

Handle the case when user is not selected in login screen, on gnome
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Handle the case when user is not selected in login screen, on gnome
Handle the case when user is not selected in login screen, on gnome.
C<$myuser> specifies the username to switch to.
If not set, it will default to C<$username>.

lib/x11utils.pm Outdated
# Handle the case when user is not selected, on gnome
=head2 select_user_gnome

select_user_gnome($myuser);
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
select_user_gnome($myuser);
select_user_gnome([$myuser]);

Now every function is documented
@DrMullings
Copy link
Contributor Author

Updated with suggestions

Copy link
Member

@SergioAtSUSE SergioAtSUSE left a comment

Choose a reason for hiding this comment

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

@asdil12, can you check for missing leading spaces / blank lines?

@asdil12 asdil12 merged commit 07c17a2 into os-autoinst:master Oct 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants