diff --git a/packages/pyright-scip/snapshots/input/builtin_imports/builtin_imports.py b/packages/pyright-scip/snapshots/input/builtin_imports/builtin_imports.py index a37b6eb3d..b6bea9e79 100644 --- a/packages/pyright-scip/snapshots/input/builtin_imports/builtin_imports.py +++ b/packages/pyright-scip/snapshots/input/builtin_imports/builtin_imports.py @@ -1,3 +1,5 @@ +# format-options: showDocs + import re from typing import Callable, Optional diff --git a/packages/pyright-scip/snapshots/input/class_nohint/class_nohint.py b/packages/pyright-scip/snapshots/input/class_nohint/class_nohint.py index 138b53db7..8ae5ca882 100644 --- a/packages/pyright-scip/snapshots/input/class_nohint/class_nohint.py +++ b/packages/pyright-scip/snapshots/input/class_nohint/class_nohint.py @@ -1,3 +1,5 @@ +# format-options: showDocs + class Example: # Note, only y has a type hint y: int diff --git a/packages/pyright-scip/snapshots/input/unique/field_docstring.py b/packages/pyright-scip/snapshots/input/unique/field_docstring.py index 748245af0..e7bd35227 100644 --- a/packages/pyright-scip/snapshots/input/unique/field_docstring.py +++ b/packages/pyright-scip/snapshots/input/unique/field_docstring.py @@ -1,3 +1,5 @@ +# format-options: showDocs + class ClassWithField: a: int diff --git a/packages/pyright-scip/snapshots/input/unique/inferred_field_docstring.py b/packages/pyright-scip/snapshots/input/unique/inferred_field_docstring.py index e0ad5150c..e1471fd57 100644 --- a/packages/pyright-scip/snapshots/input/unique/inferred_field_docstring.py +++ b/packages/pyright-scip/snapshots/input/unique/inferred_field_docstring.py @@ -1,3 +1,5 @@ +# format-options: showDocs + class ClassWithInferredField: def __init__(self, b: int): self.b = b diff --git a/packages/pyright-scip/snapshots/input/unique/module_docstring.py b/packages/pyright-scip/snapshots/input/unique/module_docstring.py index 3f210648a..5d8a1ee20 100644 --- a/packages/pyright-scip/snapshots/input/unique/module_docstring.py +++ b/packages/pyright-scip/snapshots/input/unique/module_docstring.py @@ -1,3 +1,5 @@ +# format-options: showDocs + """ This is a docstring for this module """ diff --git a/packages/pyright-scip/snapshots/output/aliased_import/actual.py b/packages/pyright-scip/snapshots/output/aliased_import/actual.py index a6253ac5f..3829699fd 100644 --- a/packages/pyright-scip/snapshots/output/aliased_import/actual.py +++ b/packages/pyright-scip/snapshots/output/aliased_import/actual.py @@ -1,26 +1,13 @@ # < definition scip-python python snapshot-util 0.1 actual/__init__: -#documentation (module) actual import aliased # ^^^^^^^ reference snapshot-util 0.1 aliased/__init__: import aliased as A # ^^^^^^^ reference snapshot-util 0.1 aliased/__init__: # ^ reference local 0 -# documentation ```python -# > (module) A -# > ``` print(A.SOME_CONSTANT) #^^^^ reference python-stdlib 3.11 builtins/print(). -#external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^ reference local 0 # ^^^^^^^^^^^^^ reference snapshot-util 0.1 aliased/SOME_CONSTANT. diff --git a/packages/pyright-scip/snapshots/output/aliased_import/aliased.py b/packages/pyright-scip/snapshots/output/aliased_import/aliased.py index 50ec12315..4335bc015 100644 --- a/packages/pyright-scip/snapshots/output/aliased_import/aliased.py +++ b/packages/pyright-scip/snapshots/output/aliased_import/aliased.py @@ -1,9 +1,5 @@ # < definition scip-python python snapshot-util 0.1 aliased/__init__: -#documentation (module) aliased SOME_CONSTANT = "Some Constant" #^^^^^^^^^^^^ definition snapshot-util 0.1 aliased/SOME_CONSTANT. -#documentation ```python -# > builtins.str -# > ``` diff --git a/packages/pyright-scip/snapshots/output/builtin_imports/builtin_imports.py b/packages/pyright-scip/snapshots/output/builtin_imports/builtin_imports.py index e14550560..184fd3056 100644 --- a/packages/pyright-scip/snapshots/output/builtin_imports/builtin_imports.py +++ b/packages/pyright-scip/snapshots/output/builtin_imports/builtin_imports.py @@ -1,6 +1,8 @@ # < definition scip-python python snapshot-util 0.1 builtin_imports/__init__: #documentation (module) builtin_imports +# format-options: showDocs + import re # ^^ reference python-stdlib 3.11 re/__init__: from typing import Callable, Optional diff --git a/packages/pyright-scip/snapshots/output/class_nohint/class_nohint.py b/packages/pyright-scip/snapshots/output/class_nohint/class_nohint.py index 7cec6c45e..97062554c 100644 --- a/packages/pyright-scip/snapshots/output/class_nohint/class_nohint.py +++ b/packages/pyright-scip/snapshots/output/class_nohint/class_nohint.py @@ -1,11 +1,14 @@ # < definition scip-python python snapshot-util 0.1 class_nohint/__init__: #documentation (module) class_nohint +# format-options: showDocs + class Example: # ^^^^^^^ definition snapshot-util 0.1 class_nohint/Example# # documentation ```python # > class Example: # > ``` +# ^^^^^^^ definition snapshot-util 0.1 class_nohint/Example# # Note, only y has a type hint y: int # ^ definition snapshot-util 0.1 class_nohint/Example#y. diff --git a/packages/pyright-scip/snapshots/output/comprehensions/comp.py b/packages/pyright-scip/snapshots/output/comprehensions/comp.py index ab89f8f67..9ac3b8261 100644 --- a/packages/pyright-scip/snapshots/output/comprehensions/comp.py +++ b/packages/pyright-scip/snapshots/output/comprehensions/comp.py @@ -1,13 +1,7 @@ # < definition scip-python python snapshot-util 0.1 comp/__init__: -#documentation (module) comp def something(x): # ^^^^^^^^^ definition snapshot-util 0.1 comp/something(). -# documentation ```python -# > def something( -# > x -# > ): -# > ``` # ^ definition snapshot-util 0.1 comp/something().(x) return 2 * x # ^ reference snapshot-util 0.1 comp/something().(x) @@ -15,76 +9,34 @@ def something(x): _ = [x for x in "should be local 0"] # ^ reference local 0 # ^ definition local 0 -# documentation ```python -# > (variable) x: str -# > ``` _ = [something(x) for x in "should be local 1"] # ^^^^^^^^^ reference snapshot-util 0.1 comp/something(). # ^ reference local 1 # ^ definition local 1 -# documentation ```python -# > (variable) x: str -# > ``` _ = [something(x) for x in "should be local 2" if x == "s"] # ^^^^^^^^^ reference snapshot-util 0.1 comp/something(). # ^ reference local 2 # ^ definition local 2 -# documentation ```python -# > (variable) x: str -# > ``` # ^ reference local 2 _ = {k: x for (k, x) in enumerate(range(10))} # ^ reference local 3 # ^ reference local 4 # ^ definition local 3 -# documentation ```python -# > (variable) k: int -# > ``` # ^ definition local 4 -# documentation ```python -# > (variable) x: int -# > ``` # ^^^^^^^^^ reference python-stdlib 3.11 builtins/enumerate# -# external documentation ```python -# > class enumerate( -# > iterable: Iterable[int], -# > start: int = ... -# > ) -# > ``` # ^^^^^ reference python-stdlib 3.11 builtins/range# -# external documentation ```python -# > class range( -# > __stop: SupportsIndex, -# > / -# > ) -# > ``` asdf = (var for var in [1, 2, 3] if var % 2 == 0) #^^^ definition snapshot-util 0.1 comp/asdf. -#documentation ```python -# > typing.Generator -# > ``` # ^^^ reference local 5 # ^^^ definition local 5 -# documentation ```python -# > (variable) var: int -# > ``` # ^^^ reference local 5 for var in asdf: # ^^^ definition snapshot-util 0.1 comp/var. # ^^^^ reference snapshot-util 0.1 comp/asdf. print(var) # ^^^^^ reference python-stdlib 3.11 builtins/print(). -# external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^^^ reference snapshot-util 0.1 comp/var. # TODO: ListComprehensions with if diff --git a/packages/pyright-scip/snapshots/output/dunder_vars/__main__.py b/packages/pyright-scip/snapshots/output/dunder_vars/__main__.py index ffcdc2677..27a5e1120 100644 --- a/packages/pyright-scip/snapshots/output/dunder_vars/__main__.py +++ b/packages/pyright-scip/snapshots/output/dunder_vars/__main__.py @@ -1,22 +1,9 @@ # < definition scip-python python snapshot-util 0.1 __main__/__init__: -#documentation (module) __main__ if __name__ == '__main__': # ^^^^^^^^ reference python-stdlib 3.11 builtins/__name__# -# external documentation ```python -# > __name__: str -# > ``` print("main") # ^^^^^ reference python-stdlib 3.11 builtins/print(). -# external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` diff --git a/packages/pyright-scip/snapshots/output/empty_project_name_version/main.py b/packages/pyright-scip/snapshots/output/empty_project_name_version/main.py index 69cfd8736..a6e76749f 100644 --- a/packages/pyright-scip/snapshots/output/empty_project_name_version/main.py +++ b/packages/pyright-scip/snapshots/output/empty_project_name_version/main.py @@ -1,11 +1,7 @@ # < definition scip-python python . . main/__init__: -#documentation (module) main def main(): # ^^^^ definition . . main/main(). -# documentation ```python -# > def main(): # -> None: -# > ``` pass main() diff --git a/packages/pyright-scip/snapshots/output/f_string/fstring.py b/packages/pyright-scip/snapshots/output/f_string/fstring.py index a40594ee7..a66718401 100644 --- a/packages/pyright-scip/snapshots/output/f_string/fstring.py +++ b/packages/pyright-scip/snapshots/output/f_string/fstring.py @@ -1,22 +1,9 @@ # < definition scip-python python snapshot-util 0.1 fstring/__init__: -#documentation (module) fstring var = ", world!" #^^ definition snapshot-util 0.1 fstring/var. -#documentation ```python -# > builtins.str -# > ``` print(f"var: hello {var}") #^^^^ reference python-stdlib 3.11 builtins/print(). -#external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^^^ reference snapshot-util 0.1 fstring/var. diff --git a/packages/pyright-scip/snapshots/output/file_from_module_import/abc/file.py b/packages/pyright-scip/snapshots/output/file_from_module_import/abc/file.py index 4da5f0c4d..6def7404c 100644 --- a/packages/pyright-scip/snapshots/output/file_from_module_import/abc/file.py +++ b/packages/pyright-scip/snapshots/output/file_from_module_import/abc/file.py @@ -1,5 +1,4 @@ # < definition scip-python python snapshot-util 0.1 `abc.file`/__init__: -#documentation (module) abc.file from xyz import nested_file # ^^^ reference snapshot-util 0.1 xyz/__init__: @@ -7,15 +6,6 @@ print(nested_file.X) #^^^^ reference python-stdlib 3.11 builtins/print(). -#external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^^^^^^^^^^^ reference snapshot-util 0.1 `xyz.nested_file`/__init__: # ^ reference snapshot-util 0.1 `xyz.nested_file`/X. diff --git a/packages/pyright-scip/snapshots/output/file_from_module_import/file_from_module.py b/packages/pyright-scip/snapshots/output/file_from_module_import/file_from_module.py index f9e22416b..ad305892e 100644 --- a/packages/pyright-scip/snapshots/output/file_from_module_import/file_from_module.py +++ b/packages/pyright-scip/snapshots/output/file_from_module_import/file_from_module.py @@ -1,5 +1,4 @@ # < definition scip-python python snapshot-util 0.1 file_from_module/__init__: -#documentation (module) file_from_module from xyz import nested_file # ^^^ reference snapshot-util 0.1 xyz/__init__: @@ -7,15 +6,6 @@ print(nested_file.X) #^^^^ reference python-stdlib 3.11 builtins/print(). -#external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^^^^^^^^^^^ reference snapshot-util 0.1 `xyz.nested_file`/__init__: # ^ reference snapshot-util 0.1 `xyz.nested_file`/X. diff --git a/packages/pyright-scip/snapshots/output/file_from_module_import/xyz/__init__.py b/packages/pyright-scip/snapshots/output/file_from_module_import/xyz/__init__.py index 44e89b298..25308027e 100644 --- a/packages/pyright-scip/snapshots/output/file_from_module_import/xyz/__init__.py +++ b/packages/pyright-scip/snapshots/output/file_from_module_import/xyz/__init__.py @@ -1,4 +1,3 @@ # < definition scip-python python snapshot-util 0.1 xyz/__init__: -#documentation (module) xyz diff --git a/packages/pyright-scip/snapshots/output/file_from_module_import/xyz/nested_file.py b/packages/pyright-scip/snapshots/output/file_from_module_import/xyz/nested_file.py index 5ab3021d7..62f17e5b7 100644 --- a/packages/pyright-scip/snapshots/output/file_from_module_import/xyz/nested_file.py +++ b/packages/pyright-scip/snapshots/output/file_from_module_import/xyz/nested_file.py @@ -1,9 +1,5 @@ # < definition scip-python python snapshot-util 0.1 `xyz.nested_file`/__init__: -#documentation (module) xyz.nested_file X = "a constant" # definition snapshot-util 0.1 `xyz.nested_file`/X. -#documentation ```python -# > builtins.str -# > ``` diff --git a/packages/pyright-scip/snapshots/output/nameparts_import/nameparts.py b/packages/pyright-scip/snapshots/output/nameparts_import/nameparts.py index ae1223cc5..e748aae63 100644 --- a/packages/pyright-scip/snapshots/output/nameparts_import/nameparts.py +++ b/packages/pyright-scip/snapshots/output/nameparts_import/nameparts.py @@ -1,5 +1,4 @@ # < definition scip-python python snapshot-util 0.1 nameparts/__init__: -#documentation (module) nameparts import importlib.resources # ^^^^^^^^^^^^^^^^^^^ reference python-stdlib 3.11 `importlib.resources`/__init__: @@ -7,14 +6,6 @@ importlib.resources.read_text('pre_commit.resources', 'filename') #^^^^^^^^^^^^^^^^^^ reference python-stdlib 3.11 `importlib.resources`/__init__: # ^^^^^^^^^ reference local 0 -# documentation ```python -# > def read_text( -# > package: Package, -# > resource: Resource, -# > encoding: str = "utf-8", -# > errors: str = "strict" -# > ) -> str: -# > ``` importlib.resources.read_text('pre_commit.resources', 'filename') #^^^^^^^^ reference python-stdlib 3.11 `importlib.resources`/__init__: # ^^^^^^^^^ reference local 0 diff --git a/packages/pyright-scip/snapshots/output/nested_items/src/__init__.py b/packages/pyright-scip/snapshots/output/nested_items/src/__init__.py index 4cd70ced8..00291ef7a 100644 --- a/packages/pyright-scip/snapshots/output/nested_items/src/__init__.py +++ b/packages/pyright-scip/snapshots/output/nested_items/src/__init__.py @@ -1,4 +1,3 @@ # < definition scip-python python snapshot-util 0.1 src/__init__: -#documentation (module) src diff --git a/packages/pyright-scip/snapshots/output/nested_items/src/foo/__init__.py b/packages/pyright-scip/snapshots/output/nested_items/src/foo/__init__.py index 5f6716acd..39b336df6 100644 --- a/packages/pyright-scip/snapshots/output/nested_items/src/foo/__init__.py +++ b/packages/pyright-scip/snapshots/output/nested_items/src/foo/__init__.py @@ -1,4 +1,3 @@ # < definition scip-python python snapshot-util 0.1 `src.foo`/__init__: -#documentation (module) src.foo diff --git a/packages/pyright-scip/snapshots/output/nested_items/src/foo/bar/__init__.py b/packages/pyright-scip/snapshots/output/nested_items/src/foo/bar/__init__.py index 7b4b21e25..9c0dc5e9b 100644 --- a/packages/pyright-scip/snapshots/output/nested_items/src/foo/bar/__init__.py +++ b/packages/pyright-scip/snapshots/output/nested_items/src/foo/bar/__init__.py @@ -1,14 +1,8 @@ # < definition scip-python python snapshot-util 0.1 `src.foo.bar`/__init__: -#documentation (module) src.foo.bar class InitClass: # ^^^^^^^^^ definition snapshot-util 0.1 `src.foo.bar`/InitClass# -# documentation ```python -# > class InitClass: -# > ``` +# ^^^^^^^^^ definition snapshot-util 0.1 `src.foo.bar`/InitClass# init_item = 10 # ^^^^^^^^^ definition snapshot-util 0.1 `src.foo.bar`/InitClass#init_item. -# documentation ```python -# > builtins.int -# > ``` diff --git a/packages/pyright-scip/snapshots/output/nested_items/src/foo/bar/baz/mod.py b/packages/pyright-scip/snapshots/output/nested_items/src/foo/bar/baz/mod.py index c0c2c66d5..24fa70da2 100644 --- a/packages/pyright-scip/snapshots/output/nested_items/src/foo/bar/baz/mod.py +++ b/packages/pyright-scip/snapshots/output/nested_items/src/foo/bar/baz/mod.py @@ -1,30 +1,16 @@ # < definition scip-python python snapshot-util 0.1 `src.foo.bar.baz.mod`/__init__: -#documentation (module) src.foo.bar.baz.mod class SuchNestedMuchWow: # ^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 `src.foo.bar.baz.mod`/SuchNestedMuchWow# -# documentation ```python -# > class SuchNestedMuchWow: -# > ``` +# ^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 `src.foo.bar.baz.mod`/SuchNestedMuchWow# class_item: int = 42 # ^^^^^^^^^^ definition snapshot-util 0.1 `src.foo.bar.baz.mod`/SuchNestedMuchWow#class_item. -# documentation ```python -# > (variable) class_item: Literal[42] -# > ``` # ^^^ reference python-stdlib 3.11 builtins/int# -# external documentation ```python -# > (class) int -# > ``` class AnotherNestedMuchWow: # ^^^^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 `src.foo.bar.baz.mod`/AnotherNestedMuchWow# -# documentation ```python -# > class AnotherNestedMuchWow: -# > ``` +# ^^^^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 `src.foo.bar.baz.mod`/AnotherNestedMuchWow# other_item: int = 42 # ^^^^^^^^^^ definition snapshot-util 0.1 `src.foo.bar.baz.mod`/AnotherNestedMuchWow#other_item. -# documentation ```python -# > (variable) other_item: Literal[42] -# > ``` # ^^^ reference python-stdlib 3.11 builtins/int# diff --git a/packages/pyright-scip/snapshots/output/nested_items/src/importer.py b/packages/pyright-scip/snapshots/output/nested_items/src/importer.py index cd90cbb8b..998268aaf 100644 --- a/packages/pyright-scip/snapshots/output/nested_items/src/importer.py +++ b/packages/pyright-scip/snapshots/output/nested_items/src/importer.py @@ -1,5 +1,4 @@ # < definition scip-python python snapshot-util 0.1 `src.importer`/__init__: -#documentation (module) src.importer from foo.bar import InitClass # ^^^^^^^ reference snapshot-util 0.1 `foo.bar`/__init__: @@ -11,15 +10,6 @@ print(SuchNestedMuchWow().class_item) #^^^^ reference python-stdlib 3.11 builtins/print(). -#external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^^^^^^^^^^^^^^^^^ reference snapshot-util 0.1 `src.foo.bar.baz.mod`/SuchNestedMuchWow# # ^^^^^^^^^^ reference snapshot-util 0.1 `src.foo.bar.baz.mod`/SuchNestedMuchWow#class_item. print(AnotherNestedMuchWow().other_item) diff --git a/packages/pyright-scip/snapshots/output/nested_items/src/long_importer.py b/packages/pyright-scip/snapshots/output/nested_items/src/long_importer.py index bc76513e4..c945fde00 100644 --- a/packages/pyright-scip/snapshots/output/nested_items/src/long_importer.py +++ b/packages/pyright-scip/snapshots/output/nested_items/src/long_importer.py @@ -1,20 +1,10 @@ # < definition scip-python python snapshot-util 0.1 `src.long_importer`/__init__: -#documentation (module) src.long_importer import foo.bar.baz.mod # ^^^^^^^^^^^^^^^ reference snapshot-util 0.1 `foo.bar.baz.mod`/__init__: print(foo.bar.baz.mod.SuchNestedMuchWow) #^^^^ reference python-stdlib 3.11 builtins/print(). -#external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^^^^^^^^^^^^^^^ reference snapshot-util 0.1 `foo.bar.baz.mod`/__init__: # ^^^^^^^^^^^^^^^^^ reference snapshot-util 0.1 `src.foo.bar.baz.mod`/SuchNestedMuchWow# diff --git a/packages/pyright-scip/snapshots/output/odd_pkg_name_1/main.py b/packages/pyright-scip/snapshots/output/odd_pkg_name_1/main.py index 4baa23eeb..e732449a4 100644 --- a/packages/pyright-scip/snapshots/output/odd_pkg_name_1/main.py +++ b/packages/pyright-scip/snapshots/output/odd_pkg_name_1/main.py @@ -1,11 +1,7 @@ # < definition scip-python python package with space 0.1 main/__init__: -#documentation (module) main def main(): # ^^^^ definition package with space 0.1 main/main(). -# documentation ```python -# > def main(): # -> None: -# > ``` pass main() diff --git a/packages/pyright-scip/snapshots/output/pyproject_1/main.py b/packages/pyright-scip/snapshots/output/pyproject_1/main.py index 45eff829e..eb2e64294 100644 --- a/packages/pyright-scip/snapshots/output/pyproject_1/main.py +++ b/packages/pyright-scip/snapshots/output/pyproject_1/main.py @@ -1,11 +1,7 @@ # < definition scip-python python abc 16.05 main/__init__: -#documentation (module) main def main(): # ^^^^ definition abc 16.05 main/main(). -# documentation ```python -# > def main(): # -> None: -# > ``` pass main() diff --git a/packages/pyright-scip/snapshots/output/relative_import/bar.py b/packages/pyright-scip/snapshots/output/relative_import/bar.py index 2f48cc291..2dc2f5f07 100644 --- a/packages/pyright-scip/snapshots/output/relative_import/bar.py +++ b/packages/pyright-scip/snapshots/output/relative_import/bar.py @@ -1,5 +1,4 @@ # < definition scip-python python snapshot-util 0.1 bar/__init__: -#documentation (module) bar from .foo import exported_function # ^^^^ reference snapshot-util 0.1 foo/__init__: diff --git a/packages/pyright-scip/snapshots/output/relative_import/foo.py b/packages/pyright-scip/snapshots/output/relative_import/foo.py index 250b49800..3ae21c4ab 100644 --- a/packages/pyright-scip/snapshots/output/relative_import/foo.py +++ b/packages/pyright-scip/snapshots/output/relative_import/foo.py @@ -1,45 +1,25 @@ # < definition scip-python python snapshot-util 0.1 foo/__init__: -#documentation (module) foo def exported_function(): # ^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 foo/exported_function(). -# documentation ```python -# > def exported_function(): # -> Literal['f... -# > ``` return "function" class MyClass: # ^^^^^^^ definition snapshot-util 0.1 foo/MyClass# -# documentation ```python -# > class MyClass: -# > ``` -# documentation This is a class and it is cool +# ^^^^^^^ definition snapshot-util 0.1 foo/MyClass# """This is a class and it is cool""" def __init__(self): # ^^^^^^^^ definition snapshot-util 0.1 foo/MyClass#__init__(). -# documentation ```python -# > def __init__( -# > self -# > ) -> None: -# > ``` # ^^^^ definition snapshot-util 0.1 foo/MyClass#__init__().(self) pass def exported_function(self): # ^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 foo/MyClass#exported_function(). -# documentation ```python -# > def exported_function( -# > self -# > ): # -> Literal['exported']: -# > ``` # ^^^^ definition snapshot-util 0.1 foo/MyClass#exported_function().(self) return "exported" this_class = MyClass() #^^^^^^^^^ definition snapshot-util 0.1 foo/this_class. -#documentation ```python -# > foo.MyClass -# > ``` # ^^^^^^^ reference snapshot-util 0.1 foo/MyClass# diff --git a/packages/pyright-scip/snapshots/output/request_goofiness/goofy.py b/packages/pyright-scip/snapshots/output/request_goofiness/goofy.py index 2306e980e..ace8ab824 100644 --- a/packages/pyright-scip/snapshots/output/request_goofiness/goofy.py +++ b/packages/pyright-scip/snapshots/output/request_goofiness/goofy.py @@ -1,20 +1,10 @@ # < definition scip-python python snapshot-util 0.1 goofy/__init__: -#documentation (module) goofy import requests # ^^^^^^^^ reference requests 2.0.0 requests/__init__: print(requests.get("https://sourcegraph.com")) #^^^^ reference python-stdlib 3.11 builtins/print(). -#external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^^^^^^^^ reference requests 2.0.0 requests/__init__: # ^^^ reference requests 2.0.0 `requests.api`/get(). diff --git a/packages/pyright-scip/snapshots/output/single_class/src/single_class.py b/packages/pyright-scip/snapshots/output/single_class/src/single_class.py index 35b12aa7c..1cd64125e 100644 --- a/packages/pyright-scip/snapshots/output/single_class/src/single_class.py +++ b/packages/pyright-scip/snapshots/output/single_class/src/single_class.py @@ -1,51 +1,23 @@ # < definition scip-python python snapshot-util 0.1 `src.single_class`/__init__: -#documentation (module) src.single_class class ExampleClass: # ^^^^^^^^^^^^ definition snapshot-util 0.1 `src.single_class`/ExampleClass# -# documentation ```python -# > class ExampleClass: -# > ``` +# ^^^^^^^^^^^^ definition snapshot-util 0.1 `src.single_class`/ExampleClass# a: int # ^ definition snapshot-util 0.1 `src.single_class`/ExampleClass#a. -# documentation ```python -# > (variable) a: int -# > ``` # ^^^ reference python-stdlib 3.11 builtins/int# -# external documentation ```python -# > (class) int -# > ``` b: int # ^ definition snapshot-util 0.1 `src.single_class`/ExampleClass#b. -# documentation ```python -# > (variable) b: int -# > ``` # ^^^ reference python-stdlib 3.11 builtins/int# c: str # ^ definition snapshot-util 0.1 `src.single_class`/ExampleClass#c. -# documentation ```python -# > (variable) c: str -# > ``` # ^^^ reference python-stdlib 3.11 builtins/str# -# external documentation ```python -# > (class) str -# > ``` static_var = "Hello World" # ^^^^^^^^^^ definition snapshot-util 0.1 `src.single_class`/ExampleClass#static_var. -# documentation ```python -# > builtins.str -# > ``` def __init__(self, a: int, b: int): # ^^^^^^^^ definition snapshot-util 0.1 `src.single_class`/ExampleClass#__init__(). -# documentation ```python -# > def __init__( -# > self, -# > a: int, -# > b: int -# > ) -> None: -# > ``` # ^^^^ definition snapshot-util 0.1 `src.single_class`/ExampleClass#__init__().(self) # ^ definition snapshot-util 0.1 `src.single_class`/ExampleClass#__init__().(a) # ^^^ reference python-stdlib 3.11 builtins/int# @@ -53,9 +25,6 @@ def __init__(self, a: int, b: int): # ^^^ reference python-stdlib 3.11 builtins/int# local_c = ", world!" # ^^^^^^^ definition local 0 -# documentation ```python -# > builtins.str -# > ``` self.a = a # ^^^^ reference snapshot-util 0.1 `src.single_class`/ExampleClass#__init__().(self) diff --git a/packages/pyright-scip/snapshots/output/single_function/src/single_function.py b/packages/pyright-scip/snapshots/output/single_function/src/single_function.py index 812f1e362..d8b46e233 100644 --- a/packages/pyright-scip/snapshots/output/single_function/src/single_function.py +++ b/packages/pyright-scip/snapshots/output/single_function/src/single_function.py @@ -1,42 +1,22 @@ # < definition scip-python python snapshot-util 0.1 `src.single_function`/__init__: -#documentation (module) src.single_function def my_cool_function(a: str) -> str: # ^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 `src.single_function`/my_cool_function(). -# documentation ```python -# > def my_cool_function( -# > a: str -# > ) -> str: -# > ``` # ^ definition snapshot-util 0.1 `src.single_function`/my_cool_function().(a) # ^^^ reference python-stdlib 3.11 builtins/str# -# external documentation ```python -# > (class) str -# > ``` # ^^^ reference python-stdlib 3.11 builtins/str# x = ", world" # ^ definition local 0 -# documentation ```python -# > builtins.str -# > ``` return a + x # ^ reference snapshot-util 0.1 `src.single_function`/my_cool_function().(a) # ^ reference local 0 def my_cool_function_2(a: str): # ^^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 `src.single_function`/my_cool_function_2(). -# documentation ```python -# > def my_cool_function_2( -# > a: str -# > ): -# > ``` # ^ definition snapshot-util 0.1 `src.single_function`/my_cool_function_2().(a) # ^^^ reference python-stdlib 3.11 builtins/str# x = ", world" # ^ definition local 1 -# documentation ```python -# > builtins.str -# > ``` return (lambda y: a + x + y)("oh no") # ^ definition local 2(y) # ^ reference snapshot-util 0.1 `src.single_function`/my_cool_function_2().(a) @@ -45,9 +25,6 @@ def my_cool_function_2(a: str): def next_level(): # ^^^^^^^^^^ definition snapshot-util 0.1 `src.single_function`/next_level(). -# documentation ```python -# > def next_level(): # -> (a: str) -> str: -# > ``` return my_cool_function # ^^^^^^^^^^^^^^^^ reference snapshot-util 0.1 `src.single_function`/my_cool_function(). diff --git a/packages/pyright-scip/snapshots/output/unique/builtin_import_refs.py b/packages/pyright-scip/snapshots/output/unique/builtin_import_refs.py index 39a77a9e2..24c04ff8c 100644 --- a/packages/pyright-scip/snapshots/output/unique/builtin_import_refs.py +++ b/packages/pyright-scip/snapshots/output/unique/builtin_import_refs.py @@ -1,46 +1,10 @@ # < definition scip-python python snapshot-util 0.1 builtin_import_refs/__init__: -#documentation (module) builtin_import_refs from typing import Any # ^^^^^^ reference python-stdlib 3.11 typing/__init__: -# external documentation ```python -# > (module) typing -# > ``` -# external documentation --- -# > -# external documentation The typing module: Support for gradual t... -# > -# > At large scale, the structure of the mod... -# > * Imports and exports, all public names... -# > * Internal helper functions: these shou... -# > * \_SpecialForm and its instances (spec... -# > Any, NoReturn, ClassVar, Union, Optional... -# > * Classes whose instances can be type a... -# > ForwardRef, TypeVar and ParamSpec -# > * The core of internal generics API: \_... -# > currently only used by Tuple and Callabl... -# > etc., are instances of either of these c... -# > * The public counterpart of the generic... -# > * Public helper functions: get\_type\_h... -# > no\_type\_check\_decorator. -# > * Generic aliases for collections.abc A... -# > * Special types: NewType, NamedTuple, T... -# > * Wrapper submodules for re and io rela... # ^^^ reference python-stdlib 3.11 typing/Any. -# external documentation ```python -# > (variable) Any: Any -# > ``` print(Any) #^^^^ reference python-stdlib 3.11 builtins/print(). -#external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^^^ reference python-stdlib 3.11 typing/Any. diff --git a/packages/pyright-scip/snapshots/output/unique/field_docstring.py b/packages/pyright-scip/snapshots/output/unique/field_docstring.py index 0be01ab7e..f8cdc5c65 100644 --- a/packages/pyright-scip/snapshots/output/unique/field_docstring.py +++ b/packages/pyright-scip/snapshots/output/unique/field_docstring.py @@ -1,11 +1,14 @@ # < definition scip-python python snapshot-util 0.1 field_docstring/__init__: #documentation (module) field_docstring +# format-options: showDocs + class ClassWithField: # ^^^^^^^^^^^^^^ definition snapshot-util 0.1 field_docstring/ClassWithField# # documentation ```python # > class ClassWithField: # > ``` +# ^^^^^^^^^^^^^^ definition snapshot-util 0.1 field_docstring/ClassWithField# a: int # ^ definition snapshot-util 0.1 field_docstring/ClassWithField#a. diff --git a/packages/pyright-scip/snapshots/output/unique/grandparent_impl.py b/packages/pyright-scip/snapshots/output/unique/grandparent_impl.py index a932a6d4b..a5cebd1b7 100644 --- a/packages/pyright-scip/snapshots/output/unique/grandparent_impl.py +++ b/packages/pyright-scip/snapshots/output/unique/grandparent_impl.py @@ -1,48 +1,28 @@ # < definition scip-python python snapshot-util 0.1 grandparent_impl/__init__: -#documentation (module) grandparent_impl class A: # ^ definition snapshot-util 0.1 grandparent_impl/A# -# documentation ```python -# > class A: -# > ``` +# ^ definition snapshot-util 0.1 grandparent_impl/A# def grandparent(self) -> bool: # ^^^^^^^^^^^ definition snapshot-util 0.1 grandparent_impl/A#grandparent(). -# documentation ```python -# > def grandparent( -# > self -# > ) -> bool: -# > ``` # ^^^^ definition snapshot-util 0.1 grandparent_impl/A#grandparent().(self) # ^^^^ reference python-stdlib 3.11 builtins/bool# -# external documentation ```python -# > (class) bool -# > ``` return True class B(A): # ^ definition snapshot-util 0.1 grandparent_impl/B# -# documentation ```python -# > class B(A): -# > ``` # relationship implementation scip-python python snapshot-util 0.1 grandparent_impl/A# +# ^ definition snapshot-util 0.1 grandparent_impl/B# # ^ reference snapshot-util 0.1 grandparent_impl/A# ... class C(B): # ^ definition snapshot-util 0.1 grandparent_impl/C# -# documentation ```python -# > class C(B): -# > ``` # relationship implementation scip-python python snapshot-util 0.1 grandparent_impl/B# +# ^ definition snapshot-util 0.1 grandparent_impl/C# # ^ reference snapshot-util 0.1 grandparent_impl/B# def grandparent(self) -> bool: # ^^^^^^^^^^^ definition snapshot-util 0.1 grandparent_impl/C#grandparent(). -# documentation ```python -# > def grandparent( -# > self -# > ) -> bool: -# > ``` # relationship implementation scip-python python snapshot-util 0.1 grandparent_impl/A#grandparent(). # ^^^^ definition snapshot-util 0.1 grandparent_impl/C#grandparent().(self) # ^^^^ reference python-stdlib 3.11 builtins/bool# diff --git a/packages/pyright-scip/snapshots/output/unique/inferred_field_docstring.py b/packages/pyright-scip/snapshots/output/unique/inferred_field_docstring.py index 58396834b..e3b6b088c 100644 --- a/packages/pyright-scip/snapshots/output/unique/inferred_field_docstring.py +++ b/packages/pyright-scip/snapshots/output/unique/inferred_field_docstring.py @@ -1,11 +1,14 @@ # < definition scip-python python snapshot-util 0.1 inferred_field_docstring/__init__: #documentation (module) inferred_field_docstring +# format-options: showDocs + class ClassWithInferredField: # ^^^^^^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 inferred_field_docstring/ClassWithInferredField# # documentation ```python # > class ClassWithInferredField: # > ``` +# ^^^^^^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 inferred_field_docstring/ClassWithInferredField# def __init__(self, b: int): # ^^^^^^^^ definition snapshot-util 0.1 inferred_field_docstring/ClassWithInferredField#__init__(). # documentation ```python diff --git a/packages/pyright-scip/snapshots/output/unique/inherits_class.py b/packages/pyright-scip/snapshots/output/unique/inherits_class.py index 7f1965818..018716c56 100644 --- a/packages/pyright-scip/snapshots/output/unique/inherits_class.py +++ b/packages/pyright-scip/snapshots/output/unique/inherits_class.py @@ -1,37 +1,17 @@ # < definition scip-python python snapshot-util 0.1 inherits_class/__init__: -#documentation (module) inherits_class class A: # ^ definition snapshot-util 0.1 inherits_class/A# -# documentation ```python -# > class A: -# > ``` +# ^ definition snapshot-util 0.1 inherits_class/A# def x(self) -> int: # ^ definition snapshot-util 0.1 inherits_class/A#x(). -# documentation ```python -# > def x( -# > self -# > ) -> int: -# > ``` # ^^^^ definition snapshot-util 0.1 inherits_class/A#x().(self) # ^^^ reference python-stdlib 3.11 builtins/int# -# external documentation ```python -# > (class) int -# > ``` raise NotImplemented # ^^^^^^^^^^^^^^ reference python-stdlib 3.11 builtins/NotImplemented# -# external documentation ```python -# > (variable) NotImplemented: _NotImplement... -# > ``` def unmatched(self, x: int): # ^^^^^^^^^ definition snapshot-util 0.1 inherits_class/A#unmatched(). -# documentation ```python -# > def unmatched( -# > self, -# > x: int -# > ): # -> None: -# > ``` # ^^^^ definition snapshot-util 0.1 inherits_class/A#unmatched().(self) # ^ definition snapshot-util 0.1 inherits_class/A#unmatched().(x) # ^^^ reference python-stdlib 3.11 builtins/int# @@ -39,18 +19,11 @@ def unmatched(self, x: int): class B(A): # ^ definition snapshot-util 0.1 inherits_class/B# -# documentation ```python -# > class B(A): -# > ``` # relationship implementation scip-python python snapshot-util 0.1 inherits_class/A# +# ^ definition snapshot-util 0.1 inherits_class/B# # ^ reference snapshot-util 0.1 inherits_class/A# def x(self) -> int: # ^ definition snapshot-util 0.1 inherits_class/B#x(). -# documentation ```python -# > def x( -# > self -# > ) -> int: -# > ``` # relationship implementation scip-python python snapshot-util 0.1 inherits_class/A#x(). # ^^^^ definition snapshot-util 0.1 inherits_class/B#x().(self) # ^^^ reference python-stdlib 3.11 builtins/int# @@ -58,13 +31,6 @@ def x(self) -> int: def unmatched(self, x: int, y: int): # ^^^^^^^^^ definition snapshot-util 0.1 inherits_class/B#unmatched(). -# documentation ```python -# > def unmatched( -# > self, -# > x: int, -# > y: int -# > ): # -> None: -# > ``` # ^^^^ definition snapshot-util 0.1 inherits_class/B#unmatched().(self) # ^ definition snapshot-util 0.1 inherits_class/B#unmatched().(x) # ^^^ reference python-stdlib 3.11 builtins/int# @@ -74,11 +40,6 @@ def unmatched(self, x: int, y: int): def unrelated(self): # ^^^^^^^^^ definition snapshot-util 0.1 inherits_class/B#unrelated(). -# documentation ```python -# > def unrelated( -# > self -# > ): # -> None: -# > ``` # ^^^^ definition snapshot-util 0.1 inherits_class/B#unrelated().(self) pass diff --git a/packages/pyright-scip/snapshots/output/unique/module_docstring.py b/packages/pyright-scip/snapshots/output/unique/module_docstring.py index 24f4dc895..09b60dbac 100644 --- a/packages/pyright-scip/snapshots/output/unique/module_docstring.py +++ b/packages/pyright-scip/snapshots/output/unique/module_docstring.py @@ -2,6 +2,8 @@ #documentation (module) module_docstring #documentation This is a docstring for this module +# format-options: showDocs + """ This is a docstring for this module """ diff --git a/packages/pyright-scip/snapshots/output/unique/multiinherits_test.py b/packages/pyright-scip/snapshots/output/unique/multiinherits_test.py index 467ff399b..a2901a76a 100644 --- a/packages/pyright-scip/snapshots/output/unique/multiinherits_test.py +++ b/packages/pyright-scip/snapshots/output/unique/multiinherits_test.py @@ -1,81 +1,43 @@ # < definition scip-python python snapshot-util 0.1 multiinherits_test/__init__: -#documentation (module) multiinherits_test class Left: # ^^^^ definition snapshot-util 0.1 multiinherits_test/Left# -# documentation ```python -# > class Left: -# > ``` +# ^^^^ definition snapshot-util 0.1 multiinherits_test/Left# def one(self) -> int: # ^^^ definition snapshot-util 0.1 multiinherits_test/Left#one(). -# documentation ```python -# > def one( -# > self -# > ) -> int: -# > ``` # ^^^^ definition snapshot-util 0.1 multiinherits_test/Left#one().(self) # ^^^ reference python-stdlib 3.11 builtins/int# -# external documentation ```python -# > (class) int -# > ``` return 1 def shared(self) -> bool: # ^^^^^^ definition snapshot-util 0.1 multiinherits_test/Left#shared(). -# documentation ```python -# > def shared( -# > self -# > ) -> bool: -# > ``` # ^^^^ definition snapshot-util 0.1 multiinherits_test/Left#shared().(self) # ^^^^ reference python-stdlib 3.11 builtins/bool# -# external documentation ```python -# > (class) bool -# > ``` return False class Right: # ^^^^^ definition snapshot-util 0.1 multiinherits_test/Right# -# documentation ```python -# > class Right: -# > ``` +# ^^^^^ definition snapshot-util 0.1 multiinherits_test/Right# def two(self): # ^^^ definition snapshot-util 0.1 multiinherits_test/Right#two(). -# documentation ```python -# > def two( -# > self -# > ): # -> Literal[2]: -# > ``` # ^^^^ definition snapshot-util 0.1 multiinherits_test/Right#two().(self) return 2 def shared(self) -> bool: # ^^^^^^ definition snapshot-util 0.1 multiinherits_test/Right#shared(). -# documentation ```python -# > def shared( -# > self -# > ) -> bool: -# > ``` # ^^^^ definition snapshot-util 0.1 multiinherits_test/Right#shared().(self) # ^^^^ reference python-stdlib 3.11 builtins/bool# return False class Multi(Left, Right): # ^^^^^ definition snapshot-util 0.1 multiinherits_test/Multi# -# documentation ```python -# > class Multi(Left, Right): -# > ``` # relationship implementation scip-python python snapshot-util 0.1 multiinherits_test/Left# # relationship implementation scip-python python snapshot-util 0.1 multiinherits_test/Right# +# ^^^^^ definition snapshot-util 0.1 multiinherits_test/Multi# # ^^^^ reference snapshot-util 0.1 multiinherits_test/Left# # ^^^^^ reference snapshot-util 0.1 multiinherits_test/Right# def one(self) -> int: # ^^^ definition snapshot-util 0.1 multiinherits_test/Multi#one(). -# documentation ```python -# > def one( -# > self -# > ) -> int: -# > ``` # relationship implementation scip-python python snapshot-util 0.1 multiinherits_test/Left#one(). # ^^^^ definition snapshot-util 0.1 multiinherits_test/Multi#one().(self) # ^^^ reference python-stdlib 3.11 builtins/int# @@ -83,32 +45,17 @@ def one(self) -> int: def two(self): # ^^^ definition snapshot-util 0.1 multiinherits_test/Multi#two(). -# documentation ```python -# > def two( -# > self -# > ): # -> Literal[2]: -# > ``` # relationship implementation scip-python python snapshot-util 0.1 multiinherits_test/Right#two(). # ^^^^ definition snapshot-util 0.1 multiinherits_test/Multi#two().(self) return 2 def three(self): # ^^^^^ definition snapshot-util 0.1 multiinherits_test/Multi#three(). -# documentation ```python -# > def three( -# > self -# > ): # -> Literal[3]: -# > ``` # ^^^^ definition snapshot-util 0.1 multiinherits_test/Multi#three().(self) return 3 def shared(self) -> bool: # ^^^^^^ definition snapshot-util 0.1 multiinherits_test/Multi#shared(). -# documentation ```python -# > def shared( -# > self -# > ) -> bool: -# > ``` # relationship implementation scip-python python snapshot-util 0.1 multiinherits_test/Left#shared(). # relationship implementation scip-python python snapshot-util 0.1 multiinherits_test/Right#shared(). # ^^^^ definition snapshot-util 0.1 multiinherits_test/Multi#shared().(self) diff --git a/packages/pyright-scip/snapshots/output/unique/property_access.py b/packages/pyright-scip/snapshots/output/unique/property_access.py index 189984d48..e2e3c6406 100644 --- a/packages/pyright-scip/snapshots/output/unique/property_access.py +++ b/packages/pyright-scip/snapshots/output/unique/property_access.py @@ -1,107 +1,41 @@ # < definition scip-python python snapshot-util 0.1 property_access/__init__: -#documentation (module) property_access from typing import Sequence # ^^^^^^ reference python-stdlib 3.11 typing/__init__: -# external documentation ```python -# > (module) typing -# > ``` -# external documentation --- -# > -# external documentation The typing module: Support for gradual t... -# > -# > At large scale, the structure of the mod... -# > * Imports and exports, all public names... -# > * Internal helper functions: these shou... -# > * \_SpecialForm and its instances (spec... -# > Any, NoReturn, ClassVar, Union, Optional... -# > * Classes whose instances can be type a... -# > ForwardRef, TypeVar and ParamSpec -# > * The core of internal generics API: \_... -# > currently only used by Tuple and Callabl... -# > etc., are instances of either of these c... -# > * The public counterpart of the generic... -# > * Public helper functions: get\_type\_h... -# > no\_type\_check\_decorator. -# > * Generic aliases for collections.abc A... -# > * Special types: NewType, NamedTuple, T... -# > * Wrapper submodules for re and io rela... # ^^^^^^^^ reference python-stdlib 3.11 typing/Sequence# class PropertyClass: # ^^^^^^^^^^^^^ definition snapshot-util 0.1 property_access/PropertyClass# -# documentation ```python -# > class PropertyClass: -# > ``` +# ^^^^^^^^^^^^^ definition snapshot-util 0.1 property_access/PropertyClass# def __init__(self): # ^^^^^^^^ definition snapshot-util 0.1 property_access/PropertyClass#__init__(). -# documentation ```python -# > def __init__( -# > self -# > ) -> None: -# > ``` # ^^^^ definition snapshot-util 0.1 property_access/PropertyClass#__init__().(self) pass @property # ^^^^^^^^ reference python-stdlib 3.11 builtins/property# -# external documentation ```python -# > (class) property -# > ``` def prop_ref(self): # ^^^^^^^^ definition snapshot-util 0.1 property_access/PropertyClass#prop_ref(). -# documentation ```python -# > @property -# > def prop_ref( -# > self -# > ): # -> Literal[5]: -# > ``` # ^^^^ definition snapshot-util 0.1 property_access/PropertyClass#prop_ref().(self) return 5 xs = [PropertyClass()] #^ definition snapshot-util 0.1 property_access/xs. -#documentation ```python -# > builtins.list -# > ``` # ^^^^^^^^^^^^^ reference snapshot-util 0.1 property_access/PropertyClass# def usage(xs: Sequence[PropertyClass]): # ^^^^^ definition snapshot-util 0.1 property_access/usage(). -# documentation ```python -# > def usage( -# > xs: Sequence[PropertyClass] -# > ): # -> None: -# > ``` # ^^ definition snapshot-util 0.1 property_access/usage().(xs) # ^^^^^^^^ reference python-stdlib 3.11 typing/Sequence# # ^^^^^^^^^^^^^ reference snapshot-util 0.1 property_access/PropertyClass# def nested(): # ^^^^^^ definition snapshot-util 0.1 property_access/usage().nested(). -# documentation ```python -# > def nested(): # -> None: -# > ``` for x in xs: # ^ definition local 0 -# external documentation ```python -# > (function) def len( -# > __obj: Sized, -# > / -# > ) -> int -# > ``` # ^^ reference snapshot-util 0.1 property_access/usage().(xs) print(x.prop_ref) # ^^^^^ reference python-stdlib 3.11 builtins/print(). -# external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^ reference local 0 # ^^^^^^^^ reference snapshot-util 0.1 property_access/PropertyClass#prop_ref(). diff --git a/packages/pyright-scip/snapshots/output/unique/vars_inside_scopes.py b/packages/pyright-scip/snapshots/output/unique/vars_inside_scopes.py index 4a2109f4f..33c797a67 100644 --- a/packages/pyright-scip/snapshots/output/unique/vars_inside_scopes.py +++ b/packages/pyright-scip/snapshots/output/unique/vars_inside_scopes.py @@ -1,75 +1,26 @@ # < definition scip-python python snapshot-util 0.1 vars_inside_scopes/__init__: -#documentation (module) vars_inside_scopes from typing import List # ^^^^^^ reference python-stdlib 3.11 typing/__init__: -# external documentation ```python -# > (module) typing -# > ``` -# external documentation --- -# > -# external documentation The typing module: Support for gradual t... -# > -# > At large scale, the structure of the mod... -# > * Imports and exports, all public names... -# > * Internal helper functions: these shou... -# > * \_SpecialForm and its instances (spec... -# > Any, NoReturn, ClassVar, Union, Optional... -# > * Classes whose instances can be type a... -# > ForwardRef, TypeVar and ParamSpec -# > * The core of internal generics API: \_... -# > currently only used by Tuple and Callabl... -# > etc., are instances of either of these c... -# > * The public counterpart of the generic... -# > * Public helper functions: get\_type\_h... -# > no\_type\_check\_decorator. -# > * Generic aliases for collections.abc A... -# > * Special types: NewType, NamedTuple, T... -# > * Wrapper submodules for re and io rela... # ^^^^ reference python-stdlib 3.11 typing/List. -# external documentation ```python -# > (variable) List: Type[List[_T@list]] -# > ``` class X: # ^ definition snapshot-util 0.1 vars_inside_scopes/X# -# documentation ```python -# > class X: -# > ``` +# ^ definition snapshot-util 0.1 vars_inside_scopes/X# items: List[int] # ^^^^^ definition snapshot-util 0.1 vars_inside_scopes/X#items. -# documentation ```python -# > (variable) items: List[int] -# > ``` # ^^^^ reference python-stdlib 3.11 typing/List. # ^^^ reference python-stdlib 3.11 builtins/int# -# external documentation ```python -# > (class) int -# > ``` def my_func(self): # ^^^^^^^ definition snapshot-util 0.1 vars_inside_scopes/X#my_func(). -# documentation ```python -# > def my_func( -# > self -# > ): # -> None: -# > ``` # ^^^^ definition snapshot-util 0.1 vars_inside_scopes/X#my_func().(self) for x in self.items: # ^ definition local 0 -# external documentation ```python -# > (function) def len( -# > __obj: Sized, -# > / -# > ) -> int -# > ``` # ^^^^ reference snapshot-util 0.1 vars_inside_scopes/X#my_func().(self) # ^^^^^ reference snapshot-util 0.1 vars_inside_scopes/X#items. y = x + 1 # ^ definition local 1 -# documentation ```python -# > builtins.int -# > ``` # ^ reference local 0 if 5 in self.items: @@ -77,7 +28,4 @@ def my_func(self): # ^^^^^ reference snapshot-util 0.1 vars_inside_scopes/X#items. z = "oh ya" # ^ definition local 2 -# documentation ```python -# > builtins.str -# > ``` diff --git a/packages/pyright-scip/snapshots/output/unique/walrus.py b/packages/pyright-scip/snapshots/output/unique/walrus.py index ea2a6d69b..535038ba4 100644 --- a/packages/pyright-scip/snapshots/output/unique/walrus.py +++ b/packages/pyright-scip/snapshots/output/unique/walrus.py @@ -1,47 +1,22 @@ # < definition scip-python python snapshot-util 0.1 walrus/__init__: -#documentation (module) walrus import re # ^^ reference python-stdlib 3.11 re/__init__: some_list = [1, 2, 3, 4, 5, 100, 1000] #^^^^^^^^ definition snapshot-util 0.1 walrus/some_list. -#documentation ```python -# > builtins.list -# > ``` pattern = "^[A-Za-z0-9_]*$" #^^^^^^ definition snapshot-util 0.1 walrus/pattern. -#documentation ```python -# > builtins.str -# > ``` text = "Some_name123" #^^^ definition snapshot-util 0.1 walrus/text. -#documentation ```python -# > builtins.str -# > ``` # if statement if (n := len(some_list)) > 10: # ^ definition snapshot-util 0.1 walrus/n. # ^^^ reference local 0 -# external documentation ```python -# > (function) def len( -# > __obj: Sized, -# > / -# > ) -> int -# > ``` # ^^^^^^^^^ reference snapshot-util 0.1 walrus/some_list. print(f"List is too long with {n} elements.") # ^^^^^ reference python-stdlib 3.11 builtins/print(). -# external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^ reference snapshot-util 0.1 walrus/n. if (match := re.search(pattern, text)) is not None: @@ -59,17 +34,11 @@ # comprehensions def show_some_comprehension(): # ^^^^^^^^^^^^^^^^^^^^^^^ definition snapshot-util 0.1 walrus/show_some_comprehension(). -# documentation ```python -# > def show_some_comprehension(): # -> None... -# > ``` [print(x, root) for x in some_list if (x % 2 == 0) and (root := x**0.5) > 5] # ^^^^^ reference python-stdlib 3.11 builtins/print(). # ^ reference local 1 # ^^^^ reference local 2 # ^ definition local 1 -# documentation ```python -# > (variable) x: int -# > ``` # ^^^^^^^^^ reference snapshot-util 0.1 walrus/some_list. # ^ reference local 1 # ^^^^ definition local 2 @@ -80,12 +49,6 @@ def show_some_comprehension(): while (line := input("Enter text: ")) != "quit": # ^^^^ definition snapshot-util 0.1 walrus/line. # ^^^^^ reference local 3 -# external documentation ```python -# > (function) def input( -# > __prompt: object = "", -# > / -# > ) -> str -# > ``` print(f"You entered: {line}") # ^^^^^ reference python-stdlib 3.11 builtins/print(). # ^^^^ reference snapshot-util 0.1 walrus/line. @@ -94,18 +57,9 @@ def show_some_comprehension(): # if + comprehension if any((any_n := num) < 0 for num in some_list): # ^^^ reference local 4 -# external documentation ```python -# > (function) def any( -# > __iterable: Iterable[object], -# > / -# > ) -> bool -# > ``` # ^^^^^ definition any_n. # ^^^ reference local 5 # ^^^ definition local 5 -# documentation ```python -# > (variable) num: int -# > ``` # ^^^^^^^^^ reference snapshot-util 0.1 walrus/some_list. print(f"Negative number found: {any_n}") # ^^^^^ reference python-stdlib 3.11 builtins/print(). diff --git a/packages/pyright-scip/snapshots/output/unresolved_import/unresolved.py b/packages/pyright-scip/snapshots/output/unresolved_import/unresolved.py index 602259f89..94afbc56d 100644 --- a/packages/pyright-scip/snapshots/output/unresolved_import/unresolved.py +++ b/packages/pyright-scip/snapshots/output/unresolved_import/unresolved.py @@ -1,21 +1,10 @@ # < definition scip-python python snapshot-util 0.1 unresolved/__init__: -#documentation (module) unresolved import this_is_not_real # ^^^^^^^^^^^^^^^^ reference local 0 -# documentation (module): this_is_not_real [unable to re... print(this_is_not_real.x) #^^^^ reference python-stdlib 3.11 builtins/print(). -#external documentation ```python -# > (function) def print( -# > *values: object, -# > sep: str | None = " ", -# > end: str | None = "\n", -# > file: SupportsWrite[str] | None = No... -# > flush: Literal[False] = False -# > ) -> None -# > ``` # ^^^^^^^^^^^^^^^^ reference local 0 print(this_is_not_real.x) #^^^^ reference python-stdlib 3.11 builtins/print().