docstrings | Interpret a string literal at the beginning of a function | Interpreter library

Since the function doesn't raise ValueError, the docstring shouldn't mention it. The idea of the docstring is that it says what the caller of the function should expect its result to be, and not what happens inside the function.

If I were documenting exactly what the function does as you've written it, I would write:

Set the PYTORCH_JIT environment variable to 0 when running Sphinx. This will disable script and tracing annotations (decorators).

See https://pytorch.org/docs/stable/jit.html#disable-jit-for-debugging.

Always use a string, since that will actually populate the __doc__ variable of the current file / module.

Compare this:

Maybe you need to extend your path to your sources in your conf.py.

Like this for example (if your doc is in a subdirectory):

In the Python Integrated Tools the list in the left column that says "Nothing to show" is populated from the open Projects. In the screenshot your file/directory tree shows a .vscode folder that isn't necessary to PyCharm, this would indicate that the PyCharm project folder called .idea must also have been copied from your shared project.

The solution is to delete the .idea folder and reopen PyCharm so the IDE can recreate its project folder. The reason is that the .idea folder contains a number of absolute file paths that are different between the computers.

This is very much IMHO, but I don't think enumerating all the parameters in the docstring has a lot of value if you have decent names and type annotations.

While I've read about other devs being able to cram the javadocs into the .aar file, this is not explicitly necessary at all to gain documentation and source code inspection from inside IDEs like Android Studio. In fact, looking at the way a typical java library works, it creates files like:

• foo-ver.jar
• foo-ver-sources.jar
• foo-ver-javadoc.jar

The only difference with an Android library would be having these files:

• foo-ver.aar
• foo-ver-sources.jar
• foo-ver-javadoc.jar

Which means that the sources and javadoc jars can still be copied along the .aar and the IDE will load them. Having said that, the publish example code only creates the .aar file, looking at other questions like this one I was able to modify the script to create the .aar plus the two other .jar packages:

What you're referring to are DocBlocks and are a part of WordPress' PHP Documentation Standards: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/

You can read more about the system that it's based on here: https://phpdoc.org/

In short, they're a standardised form of code documentation that can be interpreted and used in a number of ways. Your IDE for instance may be capable of displaying that information as part of its intellisense.

Secondly, does removing this cause any issue in the functioning.

Removing DocBlocks shouldn't cause anything to break but I can't see a valid reason for doing so.

I would use docstring-parser rather than re-inventing the wheel. It supports Google, ReST, and Numpydoc style docstrings.