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

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