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

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