Ufdjrw

Important Resources for Dark Age Civilizations?

Why do I get two different answers for this counting problem?

Roll the carpet

What defenses are there against being summoned by the Gate spell?

Client team has low performances and low technical skills: we always fix their work and now they stop collaborate with us. How to solve?

Character reincarnated...as a snail

Can I make popcorn with any corn?

Doing something right before you need it - expression for this?

meaning of に in 本当に?

How much of data wrangling is a data scientist's job?

"You are your self first supporter", a more proper way to say it

Malformed Address '10.10.21.08/24', must be X.X.X.X/NN or

How can I prevent hyper evolved versions of regular creatures from wiping out their cousins?

Why "Having chlorophyll without photosynthesis is actually very dangerous" and "like living with a bomb"?

LWC SFDX source push error TypeError: LWC1009: decl.moveTo is not a function

High voltage LED indicator 40-1000 VDC without additional power supply

Paid for article while in US on F-1 visa?

Why is Minecraft giving an OpenGL error?

How old can references or sources in a thesis be?

RSA: Danger of using p to create q

tikz convert color string to hex value

Watching something be written to a file live with tail

I'm flying to France today and my passport expires in less than 2 months

Can you really stack all of this on an Opportunity Attack?

get pydoc help() to ignore reST (sphinx) syntax?

Substitutions inside links in reST / SphinxMake Sphinx generate RST class documentation from pydocUsing sphinx to create context sensitive html helpCan pydoc/help() hide the documentation for inherited class methods and attributes?RESTful web service API documentation with SphinxDifference between pydoc and help()?Is there a way to prevent display of evaluated defaults in Sphinx documentation?Sphinx vs. Pydocdisplay argparse help within pydocIs there a Sphinx reST Python docstring field for yields?

.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty height:90px;width:728px;box-sizing:border-box;

0

I have some function definitions like this:

def abc(arrg1):
 """
 do something
 :param arrg1: a string like ``'gogo'``
 """
 if arrg1=='gogo':
 print('success')

which generates into a nice Sphinx HTML document formatted like this:

abc(arrg1)
 do something 

 Parameters:

• 
  arrg1 – a string like 'gogo'
  

but in the interactive terminal, it looks really confusing, especially for new users or non-programmers:

>>> help(abc)
Help on function abc in module __main__:

abc(arrg1)
 do something
 :param arrg1: a string like ``'gogo'``

I'm specifically referring to this:

``'gogo'``

it's really unhelpful for the new users, who often use these sort of pydoc help commands.

---

Is there any way to make the help output cleaner, basically ignoring/stripping the backticks?

python documentation python-sphinx pydoc

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8941926

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Python already isn't a HTML language...
  
  – U9-Forward
  Mar 8 at 2:16
  
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  IMO, using double backticks is confusing. Suggest their removal.
  
  – Steve Piercy
  Mar 8 at 5:01
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @StevePiercy confusing when in interactive mode, yes, but they make the online documentation easier to read
  
  – nmz787
  Mar 8 at 7:48
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @U9-Forward umm, I'm not sure how to respond... I'm using the documentation-generator Sphinx to generate the HTML docs...
  
  – nmz787
  Mar 8 at 7:49
  

  
  
  
  

add a comment | 

0

I have some function definitions like this:

def abc(arrg1):
 """
 do something
 :param arrg1: a string like ``'gogo'``
 """
 if arrg1=='gogo':
 print('success')

which generates into a nice Sphinx HTML document formatted like this:

abc(arrg1)
 do something 

 Parameters:

• 
  arrg1 – a string like 'gogo'
  

but in the interactive terminal, it looks really confusing, especially for new users or non-programmers:

>>> help(abc)
Help on function abc in module __main__:

abc(arrg1)
 do something
 :param arrg1: a string like ``'gogo'``

I'm specifically referring to this:

``'gogo'``

it's really unhelpful for the new users, who often use these sort of pydoc help commands.

---

Is there any way to make the help output cleaner, basically ignoring/stripping the backticks?

python documentation python-sphinx pydoc

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8941926

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Python already isn't a HTML language...
  
  – U9-Forward
  Mar 8 at 2:16
  
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  IMO, using double backticks is confusing. Suggest their removal.
  
  – Steve Piercy
  Mar 8 at 5:01
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @StevePiercy confusing when in interactive mode, yes, but they make the online documentation easier to read
  
  – nmz787
  Mar 8 at 7:48
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @U9-Forward umm, I'm not sure how to respond... I'm using the documentation-generator Sphinx to generate the HTML docs...
  
  – nmz787
  Mar 8 at 7:49
  

  
  
  
  

add a comment | 

I have some function definitions like this:

def abc(arrg1):
 """
 do something
 :param arrg1: a string like ``'gogo'``
 """
 if arrg1=='gogo':
 print('success')

which generates into a nice Sphinx HTML document formatted like this:

abc(arrg1)
 do something 

 Parameters:

• 
  arrg1 – a string like 'gogo'
  

but in the interactive terminal, it looks really confusing, especially for new users or non-programmers:

>>> help(abc)
Help on function abc in module __main__:

abc(arrg1)
 do something
 :param arrg1: a string like ``'gogo'``

I'm specifically referring to this:

``'gogo'``

it's really unhelpful for the new users, who often use these sort of pydoc help commands.

---

Is there any way to make the help output cleaner, basically ignoring/stripping the backticks?

python documentation python-sphinx pydoc

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8941926

def abc(arrg1):
 """
 do something
 :param arrg1: a string like ``'gogo'``
 """
 if arrg1=='gogo':
 print('success')

>>> help(abc)
Help on function abc in module __main__:

abc(arrg1)
 do something
 :param arrg1: a string like ``'gogo'``

``'gogo'``

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8941926

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8941926

asked Mar 8 at 1:46

nmz787nmz787

8941926

asked Mar 8 at 1:46

nmz787nmz787

8941926