diff --git a/pandas/guide/_sources/pandas_docstring.rst.txt b/pandas/guide/_sources/pandas_docstring.rst.txt index cd56b76..c210bb7 100644 --- a/pandas/guide/_sources/pandas_docstring.rst.txt +++ b/pandas/guide/_sources/pandas_docstring.rst.txt @@ -107,10 +107,18 @@ backticks. It is considered inline code: - The name of a parameter - Python code, a module, function, built-in, type, literal... (e.g. ``os``, ``list``, ``numpy.abs``, ``datetime.date``, ``True``) -- A pandas class (in the form ``:class:`~pandas.Series```) +- A pandas class (in the form ``:class:`pandas.Series```) - A pandas method (in the form ``:meth:`pandas.Series.sum```) - A pandas function (in the form ``:func:`pandas.to_datetime```) +.. note:: + To display only the last component of the linked class, method or + function, prefix it with ``~``. For example, ``:class:`~pandas.Series``` + will link to ``pandas.Series`` but only display the last part, ``Series`` + as the link text. See `Sphinx cross-referencing syntax + `_ + for details. + **Good:** .. code-block:: python diff --git a/pandas/guide/pandas_docstring.html b/pandas/guide/pandas_docstring.html index 755bc76..bd8d6a1 100644 --- a/pandas/guide/pandas_docstring.html +++ b/pandas/guide/pandas_docstring.html @@ -120,10 +120,18 @@

About docstrings and standardsos, list, numpy.abs, datetime.date, True) -
  • A pandas class (in the form :class:`~pandas.Series`)
  • +
  • A pandas class (in the form :class:`pandas.Series`)
  • A pandas method (in the form :meth:`pandas.Series.sum`)
  • A pandas function (in the form :func:`pandas.to_datetime`)
  • +

    Good:

    def add_values(arr):
         """
    diff --git a/pandas/guide/searchindex.js b/pandas/guide/searchindex.js
    index 96c40b9..b163452 100644
    --- a/pandas/guide/searchindex.js
    +++ b/pandas/guide/searchindex.js
    @@ -1 +1 @@
    -Search.setIndex({docnames:["index","organizers","pandas_docstring","pandas_pr","pandas_setup","pr_instuctions"],envversion:53,filenames:["index.rst","organizers.rst","pandas_docstring.rst","pandas_pr.rst","pandas_setup.rst","pr_instuctions.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x7efd0c0b0690":2,"10th":0,"5gb":4,"600mb":4,"7d3rc1ft3gocl3qo9eisarusn6":1,"900mb":4,"boolean":2,"case":[0,1,2,3,5],"class":2,"default":[2,4],"export":[2,4],"final":[1,2,3],"float":2,"function":[1,2,3,4],"import":[1,2],"int":2,"long":2,"new":[2,3,4],"return":3,"short":[1,3,4,5],"true":2,"try":[1,2,4,5],"while":[0,1,2,3],Adding:1,And:[0,1,2,3],But:[0,2],For:[1,2,3,4],One:1,The:[0,2,3,4,5],Then:[1,3,4],There:[0,1,2,3],These:2,Use:2,Using:1,With:[2,3,5],_chapter:1,_subplot:2,abl:3,about:1,abov:[2,3],abs:2,accept:[2,3],access:4,accur:2,activ:[0,4],actual:[0,2,3],add:[1,2,3,4],add_valu:2,added:2,adding:[1,4],adding_:1,addit:[2,4],address:3,advanc:2,after:[2,3,4,5],again:[1,3],age:1,agenc:1,akogun:[2,3,4],algorithm:2,alia:2,alias:2,all:[0,1,2,3,4,5],allow:[2,5],alreadi:[1,2,3],also:[0,1,3,5],although:5,alwai:[1,2],amaz:1,among:1,amount:2,anaconda:[3,4],ani:[1,2,3,5],anim:2,announc:1,anoth:[1,2,4,5],answer:1,ant:2,antelop:2,anyon:[1,5],anyth:[1,2],api:0,appear:5,appreci:1,approach:1,area:1,arg:2,argument:2,around:[0,1,2,4],arr:2,arrai:2,arriv:1,ascii_lowercas:2,ask:[1,5],aspect:2,assign:[3,4],assum:2,assur:1,astyp:2,attend:1,attent:2,authus:1,automat:[2,3],avail:3,avoid:[1,2],axes:2,axessubplot:2,axi:2,back:5,background:1,backtick:2,bad:[1,2],bar:[1,2],base:[0,1,2],bash:[4,5],bashrc:4,basic:[1,2],bear:2,becaus:3,becom:2,befor:[0,1,2,3],begin:2,behavior:[1,2],being:[1,2],below:[2,4,5],benefit:0,besid:[2,4],best:1,better:[0,1,2],between:[1,2],bin:4,bird:2,blank:[2,3],blob:1,block:2,blue:2,bodi:3,bold:2,bool:2,both:[2,4],bottleneck:1,bound:2,box:[1,3],bracket:[2,3],branch:[1,3],branch_nam:4,bring:4,browser:3,build:[2,3,4],build_ext:[3,4],built:2,bulli:1,button:[1,3,4,5],calendar:1,call:2,can:[1,2,3,4],capabl:1,capit:2,care:0,case_sensit:2,cast:2,cat:2,categor:2,certain:5,chang:[0,1,2,4,5],channel:1,chapter:[1,4],charact:4,charg:1,check:[1,3,4],checkbox:3,checklist:3,checkout:[1,4],choic:2,chose:4,citi:1,clarif:3,click:[1,3,4,5],clone:[1,4],close:2,code:[1,2,3,5],colon:2,color:2,column:2,com:[1,3,4,5],combin:5,come:1,comfort:1,comma:2,command:[3,4,5],comment:[2,3],commit:[1,5],common:[1,2],commun:4,compact:2,compani:1,compar:[1,3],compat:2,complementari:2,complex:2,complic:5,compress:2,comput:[1,2,4,5],concept:2,concern:1,concis:2,conda:[3,4],confirm:[],connect:4,consid:[1,2],consist:2,construct:3,contact:[1,4],contain:[2,3,4,5],content:5,context:2,continu:[2,3,5],contribut:[1,3,4,5],contributor:3,control:[1,5],convent:[0,3],coo_matrix:2,cool:5,copi:[1,2,3,4,5],core:1,could:[0,1,2,3],counter:2,coupl:1,courtesi:1,cow:2,cpu:2,creat:[1,2,3],cumbersom:2,curli:2,current:[2,3],cython:[3,4],dai:[0,4],data:[1,2],datafram:[0,2,3],dataset:[],date:[0,2],datetim:2,deal:2,decid:[1,2],decim:2,decis:1,def:2,defin:2,definit:2,depend:[1,4],describ:[2,3],descript:[1,2,3,4],desk:1,desktop:5,detail:[1,2,4],determinist:2,dev:[3,4],develop:[1,3,4],df1:2,df2:2,df3:2,df_main:2,df_to_join:2,dict:2,diff:3,differ:[1,2,5],difficult:1,digniti:1,dir:[3,4],direct:2,directli:[1,2],directori:4,disappoint:1,discourag:3,discov:[1,2],discrimin:1,discuss:[1,2],displai:2,distribut:[1,2],divers:1,doc:[1,3],docstr:[0,1,4],docstring_head:4,document:[1,2,3,4],doe:[1,2,4],doesn:[1,2],dog:2,doing:[2,4,5],don:[3,4],done:1,dont:5,dot:[2,3],doubl:2,download:[4,5],drink:1,dropna:2,dtype:2,duplic:1,dure:[0,1,4],each:[1,2,3,4],earlier:[1,5],easi:[0,1,2],easier:[1,2],edit:1,editor:4,effort:[0,1],either:1,electr:1,element:2,ellipsi:2,els:1,emac:4,email:[1,4],employ:1,encod:2,end:[1,2,3,5],engin:1,enjoi:[1,3],enjoy:1,enough:2,enrich:1,entrepreneurship:1,entri:[1,3],env:4,enviro:5,environ:1,equival:[2,4],error:2,especi:2,essenti:2,etc:[2,3],ethnic:1,even:[1,2],event:0,eventbrit:1,everi:[0,1,2],everybodi:1,everyon:1,everyth:1,exact:[1,2],exampl:[0,3,4],excel:1,except:[2,3],excess:2,exclus:4,execut:3,exist:2,expect:[1,3],experi:1,experienc:[1,2],explain:[2,5],explan:2,explicitli:2,express:2,extens:[0,2,3],fail:2,falcon:2,fals:2,familiar:[1,2],fast:4,featur:[3,4],fee:1,feedback:3,feel:[1,2,3],femal:1,fetch:[3,4],few:3,field:1,fig:2,file:[1,2,3,4,5],fill:[1,2],fillna:2,financi:1,find:1,finish:[2,3,4],first:[1,2,3],fit:2,fix:[0,2,3],flake8:3,float64:2,folder:[4,5],follow:[0,1,2,3,4,5],foo:2,food:5,forg:4,fork:[1,3,4,5],form:[1,2],format:[2,3],found:[2,4],foundat:1,frank:[2,3,4],free:[1,2,3,4,5],from:[0,1,2,3,4,5],frustrat:3,full:2,fulli:3,fun:1,func:2,further:2,game:5,gener:[1,3],generated_singl:3,get:[3,5],git:[1,3,4,5],github:[1,3],gitter:1,give:[1,2,5],goal:1,going:[3,5],good:[1,2],googl:1,got:1,govern:1,grammar:1,great:[0,1],green:5,group:[1,2],groupby_mean:2,gui:5,guid:[0,1,4],hacker:0,handl:2,hangout:1,happi:1,harass:1,hard:1,has:[1,2,5],hash:2,hashtag:1,have:[1,2,4],head:[2,3,4],header:2,help:[1,2,3,5],here:[1,2,5],high:[2,3],higher:2,highli:1,highlight:3,histori:3,homogen:2,host:1,how:[1,2,4],howev:2,html:[1,2,3],http:[1,3,4,5],huge:0,hundr:1,hyphen:2,idea:2,ideal:1,identifi:3,idx:2,ignor:3,illustr:2,iloc:2,immedi:2,implement:[2,3],improv:[0,1,3],includ:[2,4],inclus:1,incorrect:1,incub:1,indent:2,independ:1,index:[1,2],indic:2,infinit:2,info:1,inform:[0,4],inlin:2,inplac:[3,4],input:2,insid:[1,3],instal:[3,4,5],instead:[2,4],instruct:[0,1,3],integ:2,interest:[1,2],interest_r:2,interfac:5,internet:4,interpret:2,introduc:1,intuit:2,involv:3,issu:3,ital:2,iter:2,iteritem:2,iterrow:2,itertupl:2,its:[1,2,3],job:1,join:[1,2,4,5],junior:1,just:[0,1,2,3,4,5],keep:[1,2,4,5],kei:[2,4],keyword:2,kid:5,kind:2,kinda:5,kindli:1,know:[1,2,4,5],kwarg:2,l25:1,languag:[1,2],laptop:[4,5],last:[2,3],later:[1,5],latest:[3,4],learn:[1,3],least:1,leav:3,left:2,legaci:4,length:2,less:2,let:[1,2,5],letter:2,level:[1,2],librari:2,like:[1,2,3],line:[2,3,5],liner:0,link:[1,5],lion:2,list:[1,2],liter:2,loc:2,local:[3,4,5],localusergroup:1,locat:2,log:5,look:2,lot:1,love:5,low:2,lunch:1,machan:5,machin:5,made:[3,4],mai:[1,2,5],mail:1,main:[1,2,3,5],mainli:[1,2,3],maintain:3,make:[1,2,3,4,5],male:1,manag:1,mani:[0,1,2,3,5],manual:2,march:0,mark:3,markup:2,master:[1,3,4],match:2,matplotlib:2,matrix:2,max:2,max_spe:2,mean:[0,1,2],meaning:2,medium:2,meetup:1,member:1,menu:4,merg:[2,3,4,5],messag:3,meth:2,method:[0,1,2,3,4],microsoft:4,might:2,min:2,mind:[1,4,5],minimum:4,minor:1,minut:[1,4],miss:[2,3],mistak:[1,2,3,5],misunderstood:3,modifi:3,modul:2,moin:1,moment:1,monkei:2,more:[1,2,3,4],most:[0,1,2,3,5],much:[1,2],multi:2,multipl:[2,5],must:2,name:[2,3,4,5],nan:2,nanosecond:2,nativ:4,ndarrai:2,necessari:0,necessarili:1,need:[1,2,3,4],new_branch_nam:4,newcom:1,next:[1,2,3,4],non:1,none:2,normal:[2,3],noth:1,notic:2,now:1,num1:2,num2:2,number:[1,2],numer:2,numfocu:1,numpi:[0,2],numpydoc:2,object:2,obviou:2,occas:2,offer:1,offic:1,often:2,okai:5,old:1,omit:2,onc:[3,4,5],one:[0,1,2,3,4],ones:2,onli:[1,2,3,4],onlin:[2,3,5],open:[0,1,2,3,5],oper:2,opportun:1,opposit:2,option:[1,2,4],order:[1,2,3,4],ordin:2,org:1,organ:[0,4],orient:1,origin:[1,2,3,5],other:[1,2,5],otherwis:[2,3,4],otherwus:[],our:[1,5],out:[2,5],outofboundsdatetim:2,output:[2,3],over:[1,2],own:[2,3,4,5],packag:2,page:[0,1,3],pai:1,pair:1,panda:[1,5],pandas_dev:4,pandassprint:1,paragraph:2,paramet:[0,3],parrot:2,part:[2,3],parti:2,particip:[0,1],pass:[],past:4,path:4,patient:3,pattern:2,pdf:2,peopl:[1,2,5],pep:[2,3],per:2,permiss:[1,5],person:[1,2,3,4],photo:1,pip:4,pivot:2,place:[0,2,3],plai:5,plain:2,plan:4,plate:5,pleas:[1,3],plot:[],plu:1,point:2,polit:1,popular:5,posit:[1,2],possibl:[1,2],practic:[1,2],preced:2,predict:2,prefer:2,prepar:1,prepend:4,present:2,present_valu:2,press:5,preview:2,previou:[2,3],previous:2,primer:2,prioriti:1,pro:1,probabl:[1,2,3],problem:[1,3],proce:3,process:[1,4],product:1,program:1,programm:[1,2],project:[1,2,3,5],promot:1,prompt:[3,4],properti:2,proport:1,provid:[0,1,2,3,4,5],pub:1,pull:[1,4],purpos:2,push:1,put:1,pycharm:4,pydata:1,python:[1,2,3,5],pythonista:[0,1],pyx:3,qualiti:[1,3],quantiti:1,question:1,quick:2,quickli:1,quid:5,quiet:1,quit:2,quot:2,rabbit:2,race:1,rais:2,randint:2,randn:2,random:2,random_lett:2,rang:2,rare:[2,3],rather:5,read:2,read_csv:2,reason:[1,5],rebuild:3,recent:2,recommend:[1,2],recompil:3,record:5,refer:2,referenc:2,regardless:1,relat:[1,2],releas:3,relev:2,religion:1,remot:[3,4],remov:2,render:[2,3],repeat:2,replac:[2,4],repo:1,repor:5,repositori:[1,3,4],repositri:5,repres:2,represen:2,request:[1,4],requir:[1,2,4],respect:[1,3],rest:[1,2,4],restart:4,restaur:1,restructuredtext:2,result:[2,3],reus:3,review:[1,3],rgb:2,right:[1,2,3,4,5],roll:5,root:4,row:2,run:[2,3,4],safti:5,same:[1,2,3,5],sampl:2,sample_valu:2,save:[1,5],scientist:1,scipi:2,scm:5,script:[2,3],search:1,second:2,section:3,see:[1,3,5],seed:2,seem:1,select:4,self:2,send:[1,5],senior:3,sens:[1,2,5],sensit:2,sentenc:[2,3],separ:2,sequenc:2,seri:[0,2,3],serv:[1,2],session:[2,4],set:[0,1,2,3],setup:[3,4],sever:[2,4],sexual:1,share:[1,5],should:[1,2,3,4],show:[2,3],shown:2,side:4,sign:5,signatur:2,similar:[1,2],simpl:2,simplest:1,simpli:[2,3,4],simplic:2,sinc:5,singl:[0,1,2,3],sit:1,site:5,situat:3,skip:2,slice:2,small:2,snippet:2,social:1,softwar:[1,3,4,5],solut:1,some:[0,1,2,3,4,5],someon:1,someth:[1,2,3,5],sometim:2,soon:1,sound:5,sourc:[0,1,3,5],sours:5,space:[1,2,3,4],spars:2,sparsearrai:2,specif:[0,1,2,3,4],specifi:2,spell:1,sphinx:2,spreadsheet:1,sprint:[3,5],ssh:4,standard:[0,3],star:2,start:[1,2,3,5],startup:1,state:1,step:[1,3,4,5],still:[],str:2,straightforward:3,string:2,structur:2,studio:4,stupid:5,style:[2,3],subindex:2,subject:1,submit:[0,4],subset:2,subtl:1,subtract:2,subtyp:2,success:3,suffici:2,sum:2,summar:2,summari:[0,4],support:[1,2,4],sure:[1,3,4],sync:4,tab:4,tabl:[1,2],tail:[2,3],take:[0,4],talk:1,task:1,tech:1,technic:2,templat:3,termin:[2,3,4],test:3,text:[1,2],than:[1,2,3,4],thank:1,thei:[0,1,2,3,4],them:[1,2,3,4],thi:[0,1,2,3,4,5],thing:[1,3,5],think:[1,2,3],third:2,those:2,thousand:1,three:2,through:5,thu:5,time:1,timestamp:2,tip:1,titl:[2,3],to_csv:2,to_datetim:[2,3],togeth:0,too:[1,2,3],tool:4,top:[1,2,3,4,5],topic:[],touch:1,traceback:2,treat:1,tricki:2,trivial:1,tupl:2,tutori:[1,2,3,4],tweet:1,two:[1,2],txt:4,typo:3,unclear:3,uncomfort:1,under:[1,2,5],underrepres:1,understand:[1,2,3],undo:3,uniform:2,univers:1,unless:2,unlik:[1,3],unstack:2,updat:4,upstream:[3,4],usag:2,usb:4,use:[0,1,2,3,4],used:[2,3],useful:[1,2,3,4],user:[0,1,2,4],usernam:4,uses:2,using:[1,2,5],usual:1,valid:2,validate_docstr:3,valu:2,vari:2,variabl:2,verb:2,verbatim:3,verbos:2,veri:[0,1,2,3],verifi:3,versa:2,version:[3,4,5],via:[3,4,5],vice:2,video:[2,3,4,5],videocal:1,vim:[1,4],visit:3,visual:[2,4],wai:[1,2,4,5],wait:1,walk:5,want:[1,2,3,4,5],warn:3,wast:1,web:[3,5],websit:3,welcom:1,well:[0,3],what:[1,2,4,5],whatev:1,whatsnew:3,whcih:5,when:[1,2,4,5],where:[1,2,3,4],whether:[2,3],which:[1,2,3,4,5],whiteboard:1,who:[1,4],whole:2,why:2,wifi:1,wiki:1,window:4,without:2,word:2,work:[0,1,3,4,5],workload:4,world:[0,1],worldwid:0,worri:5,would:[1,2],wrap:2,write:1,www:1,yaml:4,year:1,yellow:[1,3],yet:4,you:[1,2,3,4],your:[0,1,4],z2fyy2lhlm1hcmnaz21hawwuy29t:1,zebra:2,zip:4},titles:["Pandas documentation sprint","Information for organizers","pandas docstring guide","Submitting your changes","Before the sprint: Set up instructions","How to create a pull request"],titleterms:{"return":2,"short":2,The:1,about:2,account:[4,5],also:2,attende:1,befor:4,beginn:5,branch:4,cake:5,can:5,chang:3,clear:3,clone:5,code:4,commit:3,commun:1,compil:4,convent:2,creat:[4,5],dai:1,docstr:[2,3],doctest:2,document:0,doe:3,don:5,environ:4,error:3,event:1,exampl:2,extend:2,first:5,forget:1,frok:5,gener:2,get:[1,2,4],github:[4,5],global:1,guid:[2,5],have:[3,5],how:5,inform:1,instruct:4,like:5,local:1,mean:5,need:5,note:2,now:5,one:5,organ:1,other:3,panda:[0,2,3,4],paramet:2,pass:2,piec:5,plot:2,publish:1,pull:[3,5],push:3,python:4,readi:1,repo:5,repositori:5,request:[3,5],rule:2,section:2,see:2,select:1,set:4,sourc:4,sprint:[0,1,4],standard:2,start:4,submit:3,summari:2,technic:3,tip:2,type:2,updat:[1,3],use:5,valid:3,venu:1,visual:3,websit:1,write:2,yield:2,you:5,your:[2,3,5],yourself:5}})
    \ No newline at end of file
    +Search.setIndex({docnames:["index","organizers","pandas_docstring","pandas_pr","pandas_setup","pr_instuctions"],envversion:53,filenames:["index.rst","organizers.rst","pandas_docstring.rst","pandas_pr.rst","pandas_setup.rst","pr_instuctions.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x7efd0c0b0690":2,"10th":0,"5gb":4,"600mb":4,"7d3rc1ft3gocl3qo9eisarusn6":1,"900mb":4,"boolean":2,"case":[0,1,2,3,5],"class":2,"default":[2,4],"export":[2,4],"final":[1,2,3],"float":2,"function":[1,2,3,4],"import":[1,2],"int":2,"long":2,"new":[2,3,4],"return":3,"short":[1,3,4,5],"true":2,"try":[1,2,4,5],"while":[0,1,2,3],Adding:1,And:[0,1,2,3],But:[0,2],For:[1,2,3,4],One:1,The:[0,2,3,4,5],Then:[1,3,4],There:[0,1,2,3],These:2,Use:2,Using:1,With:[2,3,5],_chapter:1,_subplot:2,abl:3,about:1,abov:[2,3],abs:2,accept:[2,3],access:4,accur:2,activ:[0,4],actual:[0,2,3],add:[1,2,3,4],add_valu:2,added:2,adding:[1,4],adding_:1,addit:[2,4],address:3,advanc:2,after:[2,3,4,5],again:[1,3],age:1,agenc:1,akogun:[2,3,4],algorithm:2,alia:2,alias:2,all:[0,1,2,3,4,5],allow:[2,5],alreadi:[1,2,3],also:[0,1,3,5],although:5,alwai:[1,2],amaz:1,among:1,amount:2,anaconda:[3,4],ani:[1,2,3,5],anim:2,announc:1,anoth:[1,2,4,5],answer:1,ant:2,antelop:2,anyon:[1,5],anyth:[1,2],api:0,appear:5,appreci:1,approach:1,area:1,arg:2,argument:2,around:[0,1,2,4],arr:2,arrai:2,arriv:1,ascii_lowercas:2,ask:[1,5],aspect:2,assign:[3,4],assum:2,assur:1,astyp:2,attend:1,attent:2,authus:1,automat:[2,3],avail:3,avoid:[1,2],axes:2,axessubplot:2,axi:2,back:5,background:1,backtick:2,bad:[1,2],bar:[1,2],base:[0,1,2],bash:[4,5],bashrc:4,basic:[1,2],bear:2,becaus:3,becom:2,befor:[0,1,2,3],begin:2,behavior:[1,2],being:[1,2],below:[2,4,5],benefit:0,besid:[2,4],best:1,better:[0,1,2],between:[1,2],bin:4,bird:2,blank:[2,3],blob:1,block:2,blue:2,bodi:3,bold:2,bool:2,both:[2,4],bottleneck:1,bound:2,box:[1,3],bracket:[2,3],branch:[1,3],branch_nam:4,bring:4,browser:3,build:[2,3,4],build_ext:[3,4],built:2,bulli:1,button:[1,3,4,5],calendar:1,call:2,can:[1,2,3,4],capabl:1,capit:2,care:0,case_sensit:2,cast:2,cat:2,categor:2,certain:5,chang:[0,1,2,4,5],channel:1,chapter:[1,4],charact:4,charg:1,check:[1,3,4],checkbox:3,checklist:3,checkout:[1,4],choic:2,chose:4,citi:1,clarif:3,click:[1,3,4,5],clone:[1,4],close:2,code:[1,2,3,5],colon:2,color:2,column:2,com:[1,3,4,5],combin:5,come:1,comfort:1,comma:2,command:[3,4,5],comment:[2,3],commit:[1,5],common:[1,2],commun:4,compact:2,compani:1,compar:[1,3],compat:2,complementari:2,complex:2,complic:5,compress:2,comput:[1,2,4,5],concept:2,concern:1,concis:2,conda:[3,4],confirm:[],connect:4,consid:[1,2],consist:2,construct:3,contact:[1,4],contain:[2,3,4,5],content:5,context:2,continu:[2,3,5],contribut:[1,3,4,5],contributor:3,control:[1,5],convent:[0,3],coo_matrix:2,cool:5,copi:[1,2,3,4,5],core:1,could:[0,1,2,3],counter:2,coupl:1,courtesi:1,cow:2,cpu:2,creat:[1,2,3],cumbersom:2,curli:2,current:[2,3],cython:[3,4],dai:[0,4],data:[1,2],datafram:[0,2,3],dataset:[],date:[0,2],datetim:2,deal:2,decid:[1,2],decim:2,decis:1,def:2,defin:2,definit:2,depend:[1,4],describ:[2,3],descript:[1,2,3,4],desk:1,desktop:5,detail:[1,2,4],determinist:2,dev:[3,4],develop:[1,3,4],df1:2,df2:2,df3:2,df_main:2,df_to_join:2,dict:2,diff:3,differ:[1,2,5],difficult:1,digniti:1,dir:[3,4],direct:2,directli:[1,2],directori:4,disappoint:1,discourag:3,discov:[1,2],discrimin:1,discuss:[1,2],displai:2,distribut:[1,2],divers:1,doc:[1,3],docstr:[0,1,4],docstring_head:4,document:[1,2,3,4],doe:[1,2,4],doesn:[1,2],dog:2,doing:[2,4,5],don:[3,4],done:1,dont:5,dot:[2,3],doubl:2,download:[4,5],drink:1,dropna:2,dtype:2,duplic:1,dure:[0,1,4],each:[1,2,3,4],earlier:[1,5],easi:[0,1,2],easier:[1,2],edit:1,editor:4,effort:[0,1],either:1,electr:1,element:2,ellipsi:2,els:1,emac:4,email:[1,4],employ:1,encod:2,end:[1,2,3,5],engin:1,enjoi:[1,3],enjoy:1,enough:2,enrich:1,entrepreneurship:1,entri:[1,3],env:4,enviro:5,environ:1,equival:[2,4],error:2,especi:2,essenti:2,etc:[2,3],ethnic:1,even:[1,2],event:0,eventbrit:1,everi:[0,1,2],everybodi:1,everyon:1,everyth:1,exact:[1,2],exampl:[0,3,4],excel:1,except:[2,3],excess:2,exclus:4,execut:3,exist:2,expect:[1,3],experi:1,experienc:[1,2],explain:[2,5],explan:2,explicitli:2,express:2,extens:[0,2,3],fail:2,falcon:2,fals:2,familiar:[1,2],fast:4,featur:[3,4],fee:1,feedback:3,feel:[1,2,3],femal:1,fetch:[3,4],few:3,field:1,fig:2,file:[1,2,3,4,5],fill:[1,2],fillna:2,financi:1,find:1,finish:[2,3,4],first:[1,2,3],fit:2,fix:[0,2,3],flake8:3,float64:2,folder:[4,5],follow:[0,1,2,3,4,5],foo:2,food:5,forg:4,fork:[1,3,4,5],form:[1,2],format:[2,3],found:[2,4],foundat:1,frank:[2,3,4],free:[1,2,3,4,5],from:[0,1,2,3,4,5],frustrat:3,full:2,fulli:3,fun:1,func:2,further:2,game:5,gener:[1,3],generated_singl:3,get:[3,5],git:[1,3,4,5],github:[1,3],gitter:1,give:[1,2,5],goal:1,going:[3,5],good:[1,2],googl:1,got:1,govern:1,grammar:1,great:[0,1],green:5,group:[1,2],groupby_mean:2,gui:5,guid:[0,1,4],hacker:0,handl:2,hangout:1,happi:1,harass:1,hard:1,has:[1,2,5],hash:2,hashtag:1,have:[1,2,4],head:[2,3,4],header:2,help:[1,2,3,5],here:[1,2,5],high:[2,3],higher:2,highli:1,highlight:3,histori:3,homogen:2,host:1,how:[1,2,4],howev:2,html:[1,2,3],http:[1,3,4,5],huge:0,hundr:1,hyphen:2,idea:2,ideal:1,identifi:3,idx:2,ignor:3,illustr:2,iloc:2,immedi:2,implement:[2,3],improv:[0,1,3],includ:[2,4],inclus:1,incorrect:1,incub:1,indent:2,independ:1,index:[1,2],indic:2,infinit:2,info:1,inform:[0,4],inlin:2,inplac:[3,4],input:2,insid:[1,3],instal:[3,4,5],instead:[2,4],instruct:[0,1,3],integ:2,interest:[1,2],interest_r:2,interfac:5,internet:4,interpret:2,introduc:1,intuit:2,involv:3,issu:3,ital:2,iter:2,iteritem:2,iterrow:2,itertupl:2,its:[1,2,3],job:1,join:[1,2,4,5],junior:1,just:[0,1,2,3,4,5],keep:[1,2,4,5],kei:[2,4],keyword:2,kid:5,kind:2,kinda:5,kindli:1,know:[1,2,4,5],kwarg:2,l25:1,languag:[1,2],laptop:[4,5],last:[2,3],later:[1,5],latest:[3,4],learn:[1,3],least:1,leav:3,left:2,legaci:4,length:2,less:2,let:[1,2,5],letter:2,level:[1,2],librari:2,like:[1,2,3],line:[2,3,5],liner:0,link:[1,5],lion:2,list:[1,2],liter:2,loc:2,local:[3,4,5],localusergroup:1,locat:2,log:5,look:2,lot:1,love:5,low:2,lunch:1,machan:5,machin:5,made:[3,4],mai:[1,2,5],mail:1,main:[1,2,3,5],mainli:[1,2,3],maintain:3,make:[1,2,3,4,5],male:1,manag:1,mani:[0,1,2,3,5],manual:2,march:0,mark:3,markup:2,master:[1,3,4],match:2,matplotlib:2,matrix:2,max:2,max_spe:2,mean:[0,1,2],meaning:2,medium:2,meetup:1,member:1,menu:4,merg:[2,3,4,5],messag:3,meth:2,method:[0,1,2,3,4],microsoft:4,might:2,min:2,mind:[1,4,5],minimum:4,minor:1,minut:[1,4],miss:[2,3],mistak:[1,2,3,5],misunderstood:3,modifi:3,modul:2,moin:1,moment:1,monkei:2,more:[1,2,3,4],most:[0,1,2,3,5],much:[1,2],multi:2,multipl:[2,5],must:2,name:[2,3,4,5],nan:2,nanosecond:2,nativ:4,ndarrai:2,necessari:0,necessarili:1,need:[1,2,3,4],new_branch_nam:4,newcom:1,next:[1,2,3,4],non:1,none:2,normal:[2,3],noth:1,notic:2,now:1,num1:2,num2:2,number:[1,2],numer:2,numfocu:1,numpi:[0,2],numpydoc:2,object:2,obviou:2,occas:2,offer:1,offic:1,often:2,okai:5,old:1,omit:2,onc:[3,4,5],one:[0,1,2,3,4],ones:2,onli:[1,2,3,4],onlin:[2,3,5],open:[0,1,2,3,5],oper:2,opportun:1,opposit:2,option:[1,2,4],order:[1,2,3,4],ordin:2,org:1,organ:[0,4],orient:1,origin:[1,2,3,5],other:[1,2,5],otherwis:[2,3,4],otherwus:[],our:[1,5],out:[2,5],outofboundsdatetim:2,output:[2,3],over:[1,2],own:[2,3,4,5],packag:2,page:[0,1,3],pai:1,pair:1,panda:[1,5],pandas_dev:4,pandassprint:1,paragraph:2,paramet:[0,3],parrot:2,part:[2,3],parti:2,particip:[0,1],pass:[],past:4,path:4,patient:3,pattern:2,pdf:2,peopl:[1,2,5],pep:[2,3],per:2,permiss:[1,5],person:[1,2,3,4],photo:1,pip:4,pivot:2,place:[0,2,3],plai:5,plain:2,plan:4,plate:5,pleas:[1,3],plot:[],plu:1,point:2,polit:1,popular:5,posit:[1,2],possibl:[1,2],practic:[1,2],preced:2,predict:2,prefer:2,prepar:1,prepend:4,present:2,present_valu:2,press:5,preview:2,previou:[2,3],previous:2,primer:2,prioriti:1,pro:1,probabl:[1,2,3],problem:[1,3],proce:3,process:[1,4],product:1,program:1,programm:[1,2],project:[1,2,3,5],promot:1,prompt:[3,4],properti:2,proport:1,provid:[0,1,2,3,4,5],pub:1,pull:[1,4],purpos:2,push:1,put:1,pycharm:4,pydata:1,python:[1,2,3,5],pythonista:[0,1],pyx:3,qualiti:[1,3],quantiti:1,question:1,quick:2,quickli:1,quid:5,quiet:1,quit:2,quot:2,rabbit:2,race:1,rais:2,randint:2,randn:2,random:2,random_lett:2,rang:2,rare:[2,3],rather:5,read:2,read_csv:2,reason:[1,5],rebuild:3,recent:2,recommend:[1,2],recompil:3,record:5,refer:2,referenc:2,regardless:1,relat:[1,2],releas:3,relev:2,religion:1,remot:[3,4],remov:2,render:[2,3],repeat:2,replac:[2,4],repo:1,repor:5,repositori:[1,3,4],repositri:5,repres:2,represen:2,request:[1,4],requir:[1,2,4],respect:[1,3],rest:[1,2,4],restart:4,restaur:1,restructuredtext:2,result:[2,3],reus:3,review:[1,3],rgb:2,right:[1,2,3,4,5],roll:5,root:4,row:2,run:[2,3,4],safti:5,same:[1,2,3,5],sampl:2,sample_valu:2,save:[1,5],scientist:1,scipi:2,scm:5,script:[2,3],search:1,second:2,section:3,see:[1,3,5],seed:2,seem:1,select:4,self:2,send:[1,5],senior:3,sens:[1,2,5],sensit:2,sentenc:[2,3],separ:2,sequenc:2,seri:[0,2,3],serv:[1,2],session:[2,4],set:[0,1,2,3],setup:[3,4],sever:[2,4],sexual:1,share:[1,5],should:[1,2,3,4],show:[2,3],shown:2,side:4,sign:5,signatur:2,similar:[1,2],simpl:2,simplest:1,simpli:[2,3,4],simplic:2,sinc:5,singl:[0,1,2,3],sit:1,site:5,situat:3,skip:2,slice:2,small:2,snippet:2,social:1,softwar:[1,3,4,5],solut:1,some:[0,1,2,3,4,5],someon:1,someth:[1,2,3,5],sometim:2,soon:1,sound:5,sourc:[0,1,3,5],sours:5,space:[1,2,3,4],spars:2,sparsearrai:2,specif:[0,1,2,3,4],specifi:2,spell:1,sphinx:2,spreadsheet:1,sprint:[3,5],ssh:4,standard:[0,3],star:2,start:[1,2,3,5],startup:1,state:1,step:[1,3,4,5],still:[],str:2,straightforward:3,string:2,structur:2,studio:4,stupid:5,style:[2,3],subindex:2,subject:1,submit:[0,4],subset:2,subtl:1,subtract:2,subtyp:2,success:3,suffici:2,sum:2,summar:2,summari:[0,4],support:[1,2,4],sure:[1,3,4],sync:4,tab:4,tabl:[1,2],tail:[2,3],take:[0,4],talk:1,task:1,tech:1,technic:2,templat:3,termin:[2,3,4],test:3,text:[1,2],than:[1,2,3,4],thank:1,thei:[0,1,2,3,4],them:[1,2,3,4],thi:[0,1,2,3,4,5],thing:[1,3,5],think:[1,2,3],third:2,those:2,thousand:1,three:2,through:5,thu:5,time:1,timestamp:2,tip:1,titl:[2,3],to_csv:2,to_datetim:[2,3],togeth:0,too:[1,2,3],tool:4,top:[1,2,3,4,5],topic:[],touch:1,traceback:2,treat:1,tricki:2,trivial:1,tupl:2,tutori:[1,2,3,4],tweet:1,two:[1,2],txt:4,typo:3,unclear:3,uncomfort:1,under:[1,2,5],underrepres:1,understand:[1,2,3],undo:3,uniform:2,univers:1,unless:2,unlik:[1,3],unstack:2,updat:4,upstream:[3,4],usag:2,usb:4,use:[0,1,2,3,4],used:[2,3],useful:[1,2,3,4],user:[0,1,2,4],usernam:4,uses:2,using:[1,2,5],usual:1,valid:2,validate_docstr:3,valu:2,vari:2,variabl:2,verb:2,verbatim:3,verbos:2,veri:[0,1,2,3],verifi:3,versa:2,version:[3,4,5],via:[3,4,5],vice:2,video:[2,3,4,5],videocal:1,vim:[1,4],visit:3,visual:[2,4],wai:[1,2,4,5],wait:1,walk:5,want:[1,2,3,4,5],warn:3,wast:1,web:[3,5],websit:3,welcom:1,well:[0,3],what:[1,2,4,5],whatev:1,whatsnew:3,whcih:5,when:[1,2,4,5],where:[1,2,3,4],whether:[2,3],which:[1,2,3,4,5],whiteboard:1,who:[1,4],whole:2,why:2,wifi:1,wiki:1,window:4,without:2,word:2,work:[0,1,3,4,5],workload:4,world:[0,1],worldwid:0,worri:5,would:[1,2],wrap:2,write:1,www:1,yaml:4,year:1,yellow:[1,3],yet:4,you:[1,2,3,4],your:[0,1,4],z2fyy2lhlm1hcmnaz21hawwuy29t:1,zebra:2,zip:4},titles:["Pandas documentation sprint","Information for organizers","pandas docstring guide","Submitting your changes","Before the sprint: Set up instructions","How to create a pull request"],titleterms:{"return":2,"short":2,The:1,about:2,account:[4,5],also:2,attende:1,befor:4,beginn:5,branch:4,cake:5,can:5,chang:3,clear:3,clone:5,code:4,commit:3,commun:1,compil:4,convent:2,creat:[4,5],dai:1,docstr:[2,3],doctest:2,document:0,doe:3,don:5,environ:4,error:3,event:1,exampl:2,extend:2,first:5,forget:1,frok:5,gener:2,get:[1,2,4],github:[4,5],global:1,guid:[2,5],have:[3,5],how:5,inform:1,instruct:4,like:5,local:1,mean:5,need:5,note:2,now:5,one:5,organ:1,other:3,panda:[0,2,3,4],paramet:2,pass:2,piec:5,plot:2,publish:1,pull:[3,5],push:3,python:4,readi:1,repo:5,repositori:5,request:[3,5],rule:2,section:2,see:2,select:1,set:4,sourc:4,sprint:[0,1,4],standard:2,start:4,submit:3,summari:2,technic:3,tip:2,type:2,updat:[1,3],use:5,valid:3,venu:1,visual:3,websit:1,write:2,yield:2,you:5,your:[2,3,5],yourself:5}})
    diff --git a/pandas/guide/source/pandas_docstring.rst b/pandas/guide/source/pandas_docstring.rst
    index cd56b76..c210bb7 100644
    --- a/pandas/guide/source/pandas_docstring.rst
    +++ b/pandas/guide/source/pandas_docstring.rst
    @@ -107,10 +107,18 @@ backticks. It is considered inline code:
     - The name of a parameter
     - Python code, a module, function, built-in, type, literal... (e.g. ``os``,
       ``list``, ``numpy.abs``, ``datetime.date``, ``True``)
    -- A pandas class (in the form ``:class:`~pandas.Series```)
    +- A pandas class (in the form ``:class:`pandas.Series```)
     - A pandas method (in the form ``:meth:`pandas.Series.sum```)
     - A pandas function (in the form ``:func:`pandas.to_datetime```)
     
    +.. note::
    +    To display only the last component of the linked class, method or
    +    function, prefix it with ``~``. For example, ``:class:`~pandas.Series```
    +    will link to ``pandas.Series`` but only display the last part, ``Series``
    +    as the link text. See `Sphinx cross-referencing syntax
    +    `_
    +    for details.
    +
     **Good:**
     
     .. code-block:: python