On 27/08/2025 18.57, Ethan Carter wrote:
[...]
  """Copies text file named S to text file named D."""

   This is not entirely clear, since case is significant in Python
   ("S" is not the same as "s"), and it is ambiguous whether it refers
   to a file actually named "S" or to a file whose name is provided as
   a str object bound to the name "s" in the function's source code.

This is how docstrings are traditionally written in GNU EMACS ELISP
code---they upcase argument names of the procedure being documented.  I
can't recall who taught me this, but I believe it was Robert Chassel in
his book ``An Introduction to Emacs Lisp'' that's included in the GNU
EMACS itself.

That's because LISP has a difficult relationship
with case (sensitive / insensitive).

In any environment strictly case sensitive, it's
obviously not a good idea to change case at will.

So, don't use LISP docstrings style in Python...

bye,

--

piergiorgio
--
https://mail.python.org/mailman3//lists/python-list.python.org

Reply via email to