Level 9 : What is the purpose of a docstring in Python?

Author: bhavani | Tags: docstring | 1859+ Python FAQs | Share
thread | __all__-attribute | built-in | assert | dicts | inheritance | filter-function | higher-order-function | booleans | lambda-function | interpreter | heap-memory | exception | advanced-file-operations | asyncio | integers | formatting-with-strftime | lambda-functions | def | implementation | generators | else-statement | defining-functions | conversion | data-structures-in-python | filter | file_handling | bitwise | iterator | data-structures | lambdas | complex | library | basic | pseudocode | operator-and | quantifiers-(*,-+,-?,-{}) | print-statement | math-copysign | join | immutable-data-type | constructor | error | creating-custom-modules | comprehension | introduction-to-threads | multiprocessing | reading-and-writing-files | list,-set,-and-dictionary-comprehensions | function-and-scope | for | operator-or | precedence | list-methods-and-slicing | numeric | logical-operator | feature | range | datetime.date,-datetime.time,-datetime.datetime | indexing:-loc-vs-iloc | reading-and-writing-large-files-efficiently | datetime | python-django | arithmetic-operation | comparison | identity-operators-(is,-is-not) | random | nested-loop | package-management | multithreading | python-operators | access-modifier | numpy | min-max-function | data-type | multiple-except-blocks | polymorphism | floats | python_version | iterable | objects | list-slicing | complex-number | list-method | matrix-list-comprehension | match | parsing-with-strptime | operators | loop-control | min-function | memory-management | pandas | encoding | mysql | namespace | loop-control-statements | mathematical-function | list-mutation | memory | map-function | multiple-inheritance | opening-files-(open()) | default-arguments | pass | function | operand | operator-overloading | managing-directories-with-os-and-shutil | precedence-and-associativity | bitwise-operator | postfix | error-handling | matplotlib | membership-operators-(in,-not-in) | identity-operator | parameter | fabs-function | choice | pep | global-variable | global-keyword | loop | format | keyword | control-flow | input-function | raise | arbitrary-arguments-(*args,-**kwargs) | mathematics | benefit | debugging | object-attribute | list-comprehension | input-function | python-syntax-and-structure | list-operation | python-history | introduction-to-python | list-join | design-principle | inherit | else | head-and-tail | condition | dictionary-methods | multiple-inheritance | expression | raise-statement | append | attribute | oops | __future__ | data-structure | functions | invalid-list | generators-in-python | oop | generator | pickling--unpickling | functional-programming | odd-number | control-flow | dictionary-comprehensions | name-mangling | class | python-repl | operator | exception-handling | error-handling | global | logical-operators | creating-and-starting-threads | introduction-to-multiprocessing | datatype | print | application | indentation | iterators | identifier | enumerate() | decimal | frozenset | copy | module | binary-operation | expand-tab | math | init | file-handling | conditional-statement | methods | intering | data_structure | mapping-function | python | version | gil | while-and-for-loop | docstring | data-type-conversions | type-conversion | asyncio-module | loops | virtual-environment | method | mutable | integer | counter | matrix | zip-function | formal-and-actual-parameter | python-module | namedtuple | overflow | functional-programming | destructor | arithmetic-expression | boolean-masking | writing:-write(),-writelines() | built-in-function | random-function | using-map()-for-transformations | list-comprehension | list-vs-tuple | compute | method-overloading | int | string-slicing | while-loop | dictionaries | built-in-function | exception-handling | statement | string-formatting | operations | reading:-read(),-readline(),-readlines() | max-min | threading | logical-operation | logical-operator | with-statement | data-types | recursion | sets | magic-method | filtering-and-indexing | literal-characters-and-special-characters | class-and-instance-variable | round-function | joining-and-merging-dataframes | lists | input | staticmethod | overriding-methods | indexing | string-manipulation | swapping | global-variable | directory-operations | __init_subclass__ | update | software-design | using-else-and-finally | built-in-modules | anchors-(^,-$) | dataframe-and-series-objects | dictionary | touples | escape-operator | floating-point-precision | factorial-function | id-function | syntaxerror | string-method | working-with-binary-files-(rb,-wb) | using-yield-in-functions | function-argument | string-iteration | descriptors | tuples | control-statement | string-formatting | walking-through-directories-using-os.walk() | sorting-and-ranking | installation | sorting | thread-synchronization | static-method | file-handling | file | syntax-error | recurssion | type_conversion | virtual-environment | zfill-function | tuple | regex | string | binary | sum-function | type-conversion-and-casting | yield | shallow-copy | import-method | class-and-object | async | zip | encapsulation | list | syntax-error | set-operation | class-decorators | stack | syntax | difference-between-threads-and-processes | scientific-notation | goto-function | working-with-file-paths | assignment-operators | turtle | tuple-methods | using-assertions-(assertequal,-assertraises) | immutability | using-join()-and-is_alive()-methods | aggregating-data-with-functools.reduce() | key-value-pairs | typeerror | collections | type-conversion | time-series-with-pandas | string-slicing | list-indexing | working-with-dates-and-times | round | working-with-temporary-files-using-tempfile | handling-missing-values-(fillna,-dropna) | list-comprehensions | while-loops | variable | version-check | regular-expression | counter-function | identity-operator | string-concatenation | lambda | collection | regular-expressions | return-statement | exponentiation | array | decorator | using-os-and-pathlib-modules | set | sum() | default-mutable-argument | call | thread-safe-data-structures-(queue.queue) | context-manager | single-inheritance | assignment-operator | string-methods | sys | data-structure | tuple-unpacking | strings | comment | rollback | string-method | sorted | split | test-discovery | conditional-statements | class-and-inheritance | using-the-threading-module | classes | data-type | command-line-parsing | slicing | deep-copy | unit-testing | boolean-and-non-boolean | sys-module | why-use-multiprocessing-over-threading?-(gil) | while-else-loop | slice | bitwise-operator | using-lists-as-stacks | center | boolean | conditional-statement ...