Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vemel committed Feb 19, 2020
1 parent 10ba71b commit 00c12a8
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 12 deletions.
14 changes: 7 additions & 7 deletions docs/mypy_boto3_builder/import_helpers/import_record.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def empty() -> 'ImportRecord':

### ImportRecord().get_external

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L146)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L149)

```python
def get_external(_module_name: str) -> 'ImportRecord':
Expand All @@ -69,7 +69,7 @@ Overriden by `InternalImportRecord`.

### ImportRecord().get_local_name

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L103)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L106)

```python
def get_local_name() -> str:
Expand All @@ -79,7 +79,7 @@ Get local import name.

### ImportRecord().is_builtins

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L109)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L112)

```python
def is_builtins() -> bool:
Expand All @@ -89,7 +89,7 @@ Whether import is from Python `builtins` module.

### ImportRecord().is_local

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L131)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L134)

```python
def is_local() -> bool:
Expand All @@ -99,7 +99,7 @@ Whether import is from local module.

### ImportRecord().is_standalone

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L154)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L157)

```python
def is_standalone() -> bool:
Expand All @@ -109,7 +109,7 @@ Whether import record should not be grouped.

### ImportRecord().is_third_party

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L121)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L124)

```python
def is_third_party() -> bool:
Expand All @@ -119,7 +119,7 @@ Whether import is from 3rd party module.

### ImportRecord().is_type_defs

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L115)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/import_helpers/import_record.py#L118)

```python
def is_type_defs() -> bool:
Expand Down
9 changes: 9 additions & 0 deletions docs/mypy_boto3_builder/structures/class_record.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Base class for all structures that can be rendered to a class.
- [mypy-boto3-builder](../../README.md#mypy_boto3_builder) / [Modules](../../MODULES.md#mypy-boto3-builder-modules) / [Mypy Boto3 Builder](../index.md#mypy-boto3-builder) / [Structures](index.md#structures) / ClassRecord
- [ClassRecord](#classrecord)
- [ClassRecord().alias_name](#classrecordalias_name)
- [ClassRecord().get_internal_imports](#classrecordget_internal_imports)
- [ClassRecord().get_required_import_records](#classrecordget_required_import_records)
- [ClassRecord().get_types](#classrecordget_types)
- [ClassRecord().render_alias](#classrecordrender_alias)
Expand All @@ -33,6 +34,14 @@ Base class for all structures that can be rendered to a class.
def alias_name() -> str:
```

### ClassRecord().get_internal_imports

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/class_record.py#L79)

```python
def get_internal_imports() -> Set[InternalImport]:
```

### ClassRecord().get_required_import_records

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/class_record.py#L65)
Expand Down
10 changes: 5 additions & 5 deletions docs/mypy_boto3_builder/structures/service_resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Boto3 ServiceResource.

## ServiceResource

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L19)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L18)

```python
dataclass
Expand All @@ -28,23 +28,23 @@ Boto3 ServiceResource.

### ServiceResource().get_all_names

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L53)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L52)

```python
def get_all_names() -> List[str]:
```

### ServiceResource().get_collections

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L61)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L60)

```python
def get_collections() -> List[Collection]:
```

### ServiceResource().get_sub_resources

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L74)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L73)

```python
def get_sub_resources() -> List[Resource]:
Expand All @@ -58,7 +58,7 @@ A list of sub resources.

### ServiceResource().get_types

[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L44)
[[find in source code]](https://github.com/vemel/mypy_boto3_builder/blob/master/mypy_boto3_builder/structures/service_resource.py#L43)

```python
def get_types() -> Set[FakeAnnotation]:
Expand Down

0 comments on commit 00c12a8

Please sign in to comment.