Re: [sage-devel] Re: docstring of _element_constructor_
I try to make sure the ways (I first typed methods, but then realized this was confusing) to construct the elements is available either in the parent and/or element level documentation by way of examples (maybe saying, "We can construct a foo by giving it a list::"). Best, Travis On Saturday, September 10, 2022 at 1:07:27 AM UTC+9 dim...@gmail.com wrote: > On Fri, Sep 9, 2022 at 4:43 PM davida...@gmail.com > wrote: > > > > I believe that the functionalities given by the method > _element_constructor_ should be at least mentioned in the main docstring of > the Parent. > > > > For example, when typing: > > > > sage: QQ? > > > > Then, the ouput explains to the user how to construct a rational number. > This is how I always used Sage. The documentation of _element_constructor_ > would be there for the developers that need to understand and modify it. > > Well, _things are internal, and not required to be documented. > > > > > Le vendredi 9 septembre 2022 à 05:16:27 UTC-4, axio...@yahoo.de a écrit > : > >> > >> Dear all, > >> > >> as a user, how am I supposed to access the docstring of an > _element_constructor_? > >> > >> For example, > >> > >> sage: P. = QQ[] > >> sage: P? > >> > >> does not give me any hint about the various ways to construct a > polynomial. > >> > >> If this is not possible other than "R._element_constructor_?", then, as > developers, how should we make this documentation accessible? > >> > >> Martin > > > > -- > > You received this message because you are subscribed to the Google > Groups "sage-devel" group. > > To unsubscribe from this group and stop receiving emails from it, send > an email to sage-devel+...@googlegroups.com. > > To view this discussion on the web visit > https://groups.google.com/d/msgid/sage-devel/ecf3daf3-0050-4255-84cc-472881a37e0en%40googlegroups.com > . > -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/16f92c24-d12d-475e-a4a5-ed291c357ae9n%40googlegroups.com.
Re: [sage-devel] Re: docstring of _element_constructor_
On Fri, Sep 9, 2022 at 4:43 PM davida...@gmail.com wrote: > > I believe that the functionalities given by the method _element_constructor_ > should be at least mentioned in the main docstring of the Parent. > > For example, when typing: > > sage: QQ? > > Then, the ouput explains to the user how to construct a rational number. This > is how I always used Sage. The documentation of _element_constructor_ would > be there for the developers that need to understand and modify it. Well, _things are internal, and not required to be documented. > > Le vendredi 9 septembre 2022 à 05:16:27 UTC-4, axio...@yahoo.de a écrit : >> >> Dear all, >> >> as a user, how am I supposed to access the docstring of an >> _element_constructor_? >> >> For example, >> >> sage: P. = QQ[] >> sage: P? >> >> does not give me any hint about the various ways to construct a polynomial. >> >> If this is not possible other than "R._element_constructor_?", then, as >> developers, how should we make this documentation accessible? >> >> Martin > > -- > You received this message because you are subscribed to the Google Groups > "sage-devel" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to sage-devel+unsubscr...@googlegroups.com. > To view this discussion on the web visit > https://groups.google.com/d/msgid/sage-devel/ecf3daf3-0050-4255-84cc-472881a37e0en%40googlegroups.com. -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/CAAWYfq19hRHeVNVYfgSchQ3DY2PRnQP427ykHoo2H0tuPvrCiQ%40mail.gmail.com.
[sage-devel] Re: docstring of _element_constructor_
I believe that the functionalities given by the method _element_constructor_ should be at least mentioned in the main docstring of the Parent. For example, when typing: sage: QQ? Then, the ouput explains to the user how to construct a rational number. This is how I always used Sage. The documentation of _element_constructor_ would be there for the developers that need to understand and modify it. Le vendredi 9 septembre 2022 à 05:16:27 UTC-4, axio...@yahoo.de a écrit : > Dear all, > > as a user, how am I supposed to access the docstring of an > _element_constructor_? > > For example, > > sage: P. = QQ[] > sage: P? > > does not give me any hint about the various ways to construct a polynomial. > > If this is not possible other than "R._element_constructor_?", then, as > developers, how should we make this documentation accessible? > > Martin > -- You received this message because you are subscribed to the Google Groups "sage-devel" group. To unsubscribe from this group and stop receiving emails from it, send an email to sage-devel+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sage-devel/ecf3daf3-0050-4255-84cc-472881a37e0en%40googlegroups.com.
