4407423805

Build Type

push

github

Committed by GitHub

Commit Message

Add docs command to pywbemlistener (#1288)

Run Details

32 of 38 new or added lines in 6 files covered. (84.21%)

4 existing lines in 3 files now uncovered.

5953 of 6417 relevant lines covered (92.77%)

14.56 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.91

/pywbemtools/pywbemcli/_cmd_docs.py

# (C) Copyright 2023 IBM Corp.
# (C) Copyright 2023 Inova Development Inc.
# All Rights Reserved
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Click Command definition for a docs command that calls a web browser with
the uri of the pywbemcli documentation.
"""

from __future__ import absolute_import, print_function


import click

from .._click_extensions import GENERAL_OPTS_TXT

from .pywbemcli import cli
from .._options import add_options, help_option
from .._common_cmd_actions import docs_cmd_action


@cli.command('docs', options_metavar=GENERAL_OPTS_TXT)
@add_options(help_option)
@click.pass_context
def docs_cmd(ctx):   # pylint: disable=unused-argument
    """
    Get pywbemtools documentation in web browser.

    EXPERIMENTAL

    Calls the current default web browser to display the current stable
    pywbemtools documentation in a new window.
    """
    docs_cmd_action("https://pywbemtools.readthedocs.io/en/stable/")

1	# (C) Copyright 2023 IBM Corp.
2	# (C) Copyright 2023 Inova Development Inc.
3	# All Rights Reserved
4	#
5	# Licensed under the Apache License, Version 2.0 (the "License");
6	# you may not use this file except in compliance with the License.
7	# You may obtain a copy of the License at
8	#
9	# http://www.apache.org/licenses/LICENSE-2.0
10	#
11	# Unless required by applicable law or agreed to in writing, software
12	# distributed under the License is distributed on an "AS IS" BASIS,
13	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14	# See the License for the specific language governing permissions and
15	# limitations under the License.
16	"""	16✔
17	Click Command definition for a docs command that calls a web browser with
18	the uri of the pywbemcli documentation.
19	"""
20
21	from __future__ import absolute_import, print_function	16✔
22
23
24	import click	16✔
25
26	from .._click_extensions import GENERAL_OPTS_TXT	16✔
27
28	from .pywbemcli import cli	16✔
29	from .._options import add_options, help_option	16✔
30	from .._common_cmd_actions import docs_cmd_action	16✔
31
32
33	@cli.command('docs', options_metavar=GENERAL_OPTS_TXT)	16✔
34	@add_options(help_option)	16✔
35	@click.pass_context	16✔
36	def docs_cmd(ctx): # pylint: disable=unused-argument	5✔
37	"""
38	Get pywbemtools documentation in web browser.
39
40	EXPERIMENTAL
41
42	Calls the current default web browser to display the current stable
43	pywbemtools documentation in a new window.
44	"""
NEW 45	docs_cmd_action("https://pywbemtools.readthedocs.io/en/stable/")	×

pywbem / pywbemtools / 4407423805

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous