Skip to content

Conversation

mkoeppe
Copy link
Contributor

@mkoeppe mkoeppe commented Jun 5, 2023

📚 Description

Packages such as sagemath-categories are currently mixed with optional SPKGs in the reference guide.
We separate them out as a separate category.

We also move the section on Features right next to the package list.
#35749 and follow-ups will interlink these sections.

Preview:

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

the ``dot``, ``neato``, and ``twopi`` executables from the
``graphviz`` package.
the :class:`dot`, :class:`neato`, and :class:`twopi` executables from the
:ref:`graphviz <spkg_graphviz>` package.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why :class:?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these are Features

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.

Packages of the Modularized Sage Library
----------------------------------------
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "Distribution Packages of the Sage Library", now that "distribution package" is a standard term?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, done

cat >> "$OUTPUT_INDEX" <<EOF
Runtime-Detectable Features and Conditional Doctests
----------------------------------------------------
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about just "Features and Conditional Doctests" or "Features for Conditional Doctests" or even just "Features"?

We do not need to explain what a feature is in the title. Or do you need? If not, let's make the title short.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've shortened it

sage/features/tdlib
sage/features/join_feature
sage/features/all
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about splitting feature facilities from features themselves? So sage/features, sage/features/join_feature, sage/features/all may be placed fore-front and then features afterwards.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In a separate toctree then?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe. Perhaps we may later move them three out of this section if we could find a better place for them. But I have no idea right now.

Copy link
Collaborator

@kwankyu kwankyu Jun 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A good place for the three may be found in the section

Infrastructure > Programming Facilities > Test Framework

or a new section

Infrastructure > Programming Facilities > Features Framework (or Features Facility or just Features)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, that's where they are coming from...

=================
Features, Distributions, and External Packages
==============================================
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about just "Packages and Features"?

And we list them in the order

  • standard packages
  • optional packages
  • distribution packages
  • features
  • experimental packages (perhaps after features)
  • all packages (I don't know what to do with this item. Maybe removed later)

@github-actions
Copy link

Documentation preview for this PR (built with commit 9f3a128) is ready! 🎉

Copy link
Collaborator

@kwankyu kwankyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. LGTM.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Jun 17, 2023

Thank you!

@vbraun vbraun merged commit 3e54eff into sagemath:develop Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants