Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix long function names in documentation (migrated from Trac #596) #587

Closed
networkx-trac opened this issue Jul 20, 2012 · 6 comments
Closed

Comments

@networkx-trac
Copy link

Original ticket https://networkx.lanl.gov/trac/ticket/596
Reported 2011-07-15 by @loicseguin, assigned to @loicseguin.

Many function have pretty long names when the path is included (for instance, '''networkx.algorithms.bipartite.projection.collaboration_weighted_projected_graph''') and this makes the documentation ugly. I pushed the changes to my bitbucket fork [https://bitbucket.org/loicseguin/networkx] that modifies the default template to use short names instead of long ones.

I would like to have feedback on the look of the resulting documentation before pushing it.

@networkx-trac
Copy link
Author

Comment in Trac by @loicseguin, 2011-07-15

@networkx-trac
Copy link
Author

Comment in Trac by Aric Hagberg <aric.hagberg, 2011-07-17

In [1542b8b/networkx]:
'''
#!CommitTicketReference repository="networkx" revision="1542b8bf5de984a227812fa48a6d332858375a72"
Make shorter function names in docs with templates.
Addresses #596
'''

@networkx-trac
Copy link
Author

Comment in Trac by @hagberg, 2011-07-17

That is great. I took what you did and modified it to

  1. Override the default templates automatically so you don't have to modify any of the rst files

  2. One edit in conf.py to shorten the function signatures. I'm not sure that is always good because it hides where the import comes from.

Take a look http://networkx.lanl.gov/preview/ and see what you think.

Might as well try to fix up the style sheet to improve the look while we have this ticket.
I don't like the way the parameters/returns etc. sections look.

@networkx-trac
Copy link
Author

Comment in Trac by @hagberg, 2011-07-18

Replying to [comment:3 aric]:

That is great. I took what you did and modified it to

  1. Override the default templates automatically so you don't have to modify any of the rst files

  2. One edit in conf.py to shorten the function signatures. I'm not sure that is always good because it hides where the import comes from.

Take a look http://networkx.lanl.gov/preview/ and see what you think.

Might as well try to fix up the style sheet to improve the look while we have this ticket.
I don't like the way the parameters/returns etc. sections look.

Well, it's harder to modify the output/look than I thought. So maybe it will just stay the same.

@networkx-trac
Copy link
Author

Comment in Trac by Dan Schult <dschult, 2011-07-20

In [e2d725c/networkx]:
'''
#!CommitTicketReference repository="networkx" revision="e2d725c4dd32484ef6c019f3ce92ec72aa8e6dd4"
Revise "see also" references in bipartite to use short names.
Addresses #596
'''

@networkx-trac
Copy link
Author

Comment in Trac by @hagberg, 2011-09-16

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant