var vs cvar vs ivar... What's the diff?

221 views
Skip to first unread message

Russell Weber

unread,
Dec 9, 2016, 1:50:32 AM12/9/16
to sphinx-users
I noticed that there are several ways to document variables.
ivar
cvar
and just var
However, the documentation in sphinx, ironically of course, doesn't seem to clarify the difference between them.
If they were all the same, I would hope that there would at least be some what of a statement telling potential users that they were all just the same and kept around for what ever reason..
Example:  All of these are the same however are kept around for backward compatibility.

What is the difference between these and how is their usage different?

Question also exists on stack overflow...
http://stackoverflow.com/questions/41052221/what-is-the-difference-between-var-cvar-and-ivar-in-pythons-sphinx/41052389

Komiya Takeshi

unread,
Dec 17, 2016, 12:48:57 AM12/17/16
to sphinx-users
Hi,

Unfortunately, there is no difference in these variables.
I don't know the background of them.
Anyway, I added the note to describe that.

Thanks,
Takeshi KOMIYA

2016年12月9日金曜日 15時50分32秒 UTC+9 Russell Weber:

Kevin Horn

unread,
Dec 19, 2016, 10:14:01 AM12/19/16
to sphinx...@googlegroups.com
My understanding has always been:

cvar = class variable
ivar = instance variable

Hope this helps.

(Also, I've posted an answer on the SO question, that's a bit longer, in case that helps)

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users+unsubscribe@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.


--
Kevin Horn
Reply all
Reply to author
Forward
0 new messages