semvec/pypi-packages huggingface dataset:
check-docstring 1.0.1
BD RD docstring format checker.
Requires Python: >=3.6.*

# BD RD Docstring Checker

## Usage

```bash
check_docstring PATH
```

where `PATH` can be a file or a directory. All Python scripts will be collected and checked.

## Docstring Convention

Google style docstring [ref1](https://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format/24385103#24385103) [ref2](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings) [ref3](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)

```python
def example_function(param1, param2):
    """
    This is an example of a function docstring.
    More descriptions go here.

    Args:
        param1 (int): The first parameter.
            Second line has to be indented.
        param2 (str): The second parameter.

    Returns:
        bool: True if successful, False otherwise.

    Raises:
        AttributeError: The ``Raises`` section is a list of all exceptions
            that are relevant to the interface.
        ValueError: If `param2` is equal to `param1`.
    """

    if param1 == param2:
        raise ValueError('param1 may not be equal to param2')
    return True
```

---
Last updated: 2021/11/19
orbit-pkg-SERGEI-DOLIN 0.0
lib for edu
Requires Python: >=3.8

# Orbital

This is package for education. You can use original git
[RazerM Orbital](https://github.com/RazerM/orbital)

### Example

```python
from orbital import earth, KeplerianElements, Maneuver, plot

from scipy.constants import kilo
import matplotlib.pyplot as plt

orbit = KeplerianElements.with_altitude(1000 * kilo, body=earth)
man = Maneuver.hohmann_transfer_to_altitude(10000 * kilo)
plot(orbit, title='Maneuver 1', maneuver=man)
plt.show()
```

### Documentation

For more information, view the [documentation online][doc].

  [doc]: http://pythonhosted.org/OrbitalPy/