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.

Sign up for GitHub

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

Jump to bottom

Conventions for Coding SEEALSO format #12301

Closed
sagetrac-ksmith mannequin opened this issue Jan 12, 2012 · 2 comments
Closed

Conventions for Coding SEEALSO format #12301

sagetrac-ksmith mannequin opened this issue Jan 12, 2012 · 2 comments
Assignees
@sagetrac-mvngu
Labels
c: documentation r: duplicate t: enhancement

Comments

@sagetrac-ksmith
Copy link
Mannequin

sagetrac-ksmith mannequin commented Jan 12, 2012

In the docstrings, the format:

.. SEEALSO::

Material goes here indented some from the see also above.

produces a fancy little box in the html pages similar to the note or warning boxes. However, this is not specified in the Conventions for Coding document. It would be great if the Conventions for Coding document could be appended so people will know that they can use this.

Component: documentation

Keywords: sd35.5

Reviewer: Florent Hivert

Issue created by migration from https://trac.sagemath.org/ticket/12301
@hivert
Copy link

hivert commented Feb 8, 2012

comment:1

This is a duplicate for #12078.

Please close.

@kcrisman
Copy link
Member

Reviewer: Florent Hivert

@hivert hivert mentioned this issue Feb 27, 2012
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sagetrac-mvngu sagetrac-mvngu

Labels
c: documentation r: duplicate t: enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kcrisman @jdemeyer @hivert