Alert pexpect interfaces to library interfaces

[kcrisman]

We now have several programs (e.g. Gap, Maxima)
which have both pexpect and some sort of library-ish
interface. As a user said,

How do I go about ensuring that the web documentation
for the "pexpect" interface at least includes a pointer
to the "libgap" interface? I was not at all aware of
the latter, and it appears to pretty much majorize the
former in all respects. I can understand that there may
be reasons not to retire the "pexpect" interface, but
it would be good to point "newbie" users (like me)
to the very-likely-to-be-superior libgap interface.

So we should be sure to have documentation that points
people to that in these cases.

Separately (though perhaps still on this ticket, if you
disagree open a new one and link to this one) we may wish
to convert some older documentation, particularly in tutorials,
to use library interfaces. For instance, which interface
do http://doc.sagemath.org/html/en/tutorial/interfaces.html#maxima or http://doc.sagemath.org/html/en/tutorial/interfaces.html#gap use?

Related:

• Pexpect-like interfaces based on jupyter_client #22579: Pexpect-like interfaces based on jupyter_client
• Meta-ticket: replace pexpect interface calls with library where possible #16688: Replace pexpect interface calls with library where possible

Component: documentation

Issue created by migration from https://trac.sagemath.org/ticket/22680

[slel]

Description changed:

--- 
+++ 
@@ -1,6 +1,26 @@
-We now have several programs (e.g. Gap, Maxima) which have both pexpect and some sort of library-ish interface.  As a user said, 
-> How do I go about ensuring that the web documentation for the "pexpect" interface at least includes a pointer to the "libgap" interface? I was not at all aware of the latter, and it appears to pretty much majorize the former in all respects. I can understand that there may be reasons not to retire the "pexpect" interface, but it would be good to point "newbie" users (like me) to the very-likely-to-be-superior libgap interface.
+We now have several programs (e.g. Gap, Maxima)
+which have both pexpect and some sort of library-ish
+interface.  As a user said,
 
-So we should be sure to have documentation that points people to that in these cases.  
+> How do I go about ensuring that the web documentation
+> for the "pexpect" interface at least includes a pointer
+> to the "libgap" interface? I was not at all aware of
+> the latter, and it appears to pretty much majorize the
+> former in all respects. I can understand that there may
+> be reasons not to retire the "pexpect" interface, but
+> it would be good to point "newbie" users (like me)
+> to the very-likely-to-be-superior libgap interface.
 
-Separately (though perhaps still on this ticket, if you disagree open a new one and link to this one) we may wish to convert some older documentation, particularly in tutorials, to use library interfaces.  For instance, which interface do http://doc.sagemath.org/html/en/tutorial/interfaces.html#maxima or http://doc.sagemath.org/html/en/tutorial/interfaces.html#gap use?
+So we should be sure to have documentation that points
+people to that in these cases.  
+
+Separately (though perhaps still on this ticket, if you
+disagree open a new one and link to this one) we may wish
+to convert some older documentation, particularly in tutorials,
+to use library interfaces.  For instance, which interface
+do http://doc.sagemath.org/html/en/tutorial/interfaces.html#maxima or http://doc.sagemath.org/html/en/tutorial/interfaces.html#gap use?
+
+Related:
+
+- #22579: Pexpect-like interfaces based on jupyter_client
+- #16688: Replace pexpect interface calls with library where possible

[ashutosh887]

I would like to work on this if not resolved

[Flying-Pegasus]

@kcrisman please assig this issue to me, I want to work on it.

[kcrisman]

@kcrisman <https://github.com/kcrisman> please assig this issue to me, I want to work on it.

You don't need permission to work on an issue; submit a pull request and reference this issue in it, if I recall the workflow correctly. It would need to be reviewed, of course.

[Flying-Pegasus]

Okay @kcrisman , Thank you