معرفی شرکت ها

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

توضیحات

Docstring splicing for python functions 🧬

ویژگی	مقدار
سیستم عامل	-
نام فایل	docsplice-0.1.0
نام	docsplice
نسخه کتابخانه	0.1.0
نگهدارنده	[]
ایمیل نگهدارنده	[]
نویسنده	Hannes Breytenbach
ایمیل نویسنده	hannes@saao.ac.za
آدرس صفحه اصلی	https://github.com/astromancer/docsplice
آدرس اینترنتی	https://pypi.org/project/docsplice/
مجوز	-

# DocSplice > Docstring splicing for python functions 🧬  This project allows you to splice docstrings for python functions in a convenient way using a functional decorator. This enables you to more easily create consistent documentation for your API without needing to duplicate docstring sections for functions that have the same parameter descriptions or other related content. This will ease the maintenance burden for your package documentation since the content of your function or class documentation reside in a single location in the source code, instead of being duplicated within each function body. # Install ```shell pip install docsplice ``` # Use  ### Pulling parameters from multiple sources ```python import docsplice as doc def fun1(a): """ Do something with a number. Parameters ---------- a : int The number. """ def fun2(b=0): """ Another function that does something with an integer. Parameters ---------- b : int, optional Another number! By default 0. """ @doc.splice({'Parameters[a]': fun1, 'Parameters[b] as n=7': fun2}) def combined(a, n=7): """ Some profound computation. Parameter descriptions follow: """ ``` The `Parameters` section in the docstring for `combined` has been created by the `splice` decorator. Inspecting the object in an interactive terminal reveals that the docstring has been filled: ```python combined?? ``` ``` Signature: combined(a, n=7) Docstring: Some profound computation. Parameter descriptions follow: Parameters ---------- a : int The number. n : int, optional Another number! By default 7. Source: @doc.splice({'Parameters[a]': fun1, 'Parameters[b] as n=7': fun2}) def combined(a, n=7): """ Some profound computation. Parameter descriptions follow: """ ```   # Test The [`test suite`](./tests/test_splice.py) contains further examples of how `DocSplice` can be used. Testing is done with `pytest`: ```shell pytest docsplice ``` # Contribute Contributions are welcome! 1. [Fork it!](https://github.com/astromancer/docsplice/fork>) 2. Create your feature branch\ ``git checkout -b feature/rad`` 3. Commit your changes\ ``git commit -am 'Add something rad'`` 4. Push to the branch\ ``git push origin feature/rad`` 5. Create a new Pull Request # Contact * e-mail: hannes@saao.ac.za  # License * see [LICENSE](https://github.com/astromancer/docsplice/blob/master/LICENSE.txt)

زبان مورد نیاز

مقدار	نام
>=3.8	Python

نحوه نصب

نصب پکیج whl docsplice-0.1.0:

pip install docsplice-0.1.0.whl

نصب پکیج tar.gz docsplice-0.1.0:

pip install docsplice-0.1.0.tar.gz