DOC: Explain leading dot in object references

[timhoffm]

No description provided.

[story645]

Um, I'm not sure what this means, feel like either it needs more detail (short example) or should be left out

Suggested change

	the leading dot, otherwise Sphinx will try to resolve the object only in the current
	module. See also the explanation at `Sphinx: Cross-referencing Python objects
	the leading dot, as discussed in `Sphinx: Cross-referencing Python objects

[tacaswell]

in a sphinx page you can set a "current module", if you don't use the . it looks for the name in that module, if you use the dot it will look anythere in your project.

I think this is clear enough as-is and removing this bit of the text makes this PR mostly content-less.

[story645]

I think this is clear enough as-is

You also already knew what it was getting it, while I didn't and found this explanation hard to follow. Granted, I think the explanation you just wrote "if you don't use the . it looks for the name in that module, if you use the dot it will look anythere in your project." is what I was after.

[timhoffm]

Reworded to

Note that you should typically include
the leading dot. It tells Sphinx to look for the given name in the whole project.