Python 3: Documenting modules

Question

I study how to document my code. So, I prepared a file docstrings.py and placed it in a directory. Now I would like to have a look at what I documented. In other words I want to type help(docstrings.square) and get the documentation on square function in my module.

>>> import sys
>>> sys.path.append("C:\Users\Michael\PycharmProjects\Docstrings")

Result:

SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 2-4: truncated \UXXXXXXXX escape

What's wrong?

Frédéric Hamidi · Accepted Answer · 2012-09-24 07:03:04Z

1

Backslashes have to be doubled in string literals:

>>> sys.path.append("C:\\Users\\Michael\\PycharmProjects\\Docstrings")

Unless you use a raw string:

>>> sys.path.append(r"C:\Users\Michael\PycharmProjects\Docstrings")

answered Sep 24, 2012 at 7:03

Frédéric Hamidi

264k42 gold badges497 silver badges486 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Kifsif Over a year ago

Thank you. It's working. Another question. How can I use PyDoc. I read that PyDoc explores all catalogues from sys.path and finds the selected module. But how to edit sys.path for PyDoc?

Frédéric Hamidi Over a year ago

Try modifying the PYTHONPATH environment variable. PyDoc should honor it.

Collectives™ on Stack Overflow

Python 3: Documenting modules

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related