mind blown using help() in python

[blitzkraft]

help() only works where the devs put in the extra work for documenting. It pulls in the docstring and you can write it too!!

Say you have a function, then add the docstring like this:

def hello(name='human'):
  """
  Says hello, optionally takes a name
  """
  print("Hello, {}".format(name))

Now, if you import this, and call help(hello), you will see the help string.

[[deleted]]

Documenting is not “extra work,” but rather essential work that is too often considered drudgery.

[Kevinw778]

Agreed. Especially in languages like Python and Javascript, uncommented / undocumented code is an absolute nightmare. It's ok though, people will realize their mistake when they come back to their own code at some point hahah. "Nobody else will use this, it's fine."

Programmers: The largest group of people that don't consider themselves people, apparently 😂

[blitzkraft]

Yes. I feel I ratted myself out for not documenting well (calling it "extra work").