Please provide a link to your PR that was merged. On Saturday, June 6, 2020 at 9:28:58 PM UTC+5:30, Mohit Shah wrote: > > Hello, > how to format return statement in docstring. > In my previous PR which was merged, I make it as: > > *return-type :* > * Brief explanation of what it is returning.* > > will it be okay or should I make some changes to this? > > On Wednesday, June 3, 2020 at 4:59:42 AM UTC+5:30, Aaron Meurer wrote: >> >> I think the order you showed in your diagram is correct. They should go >> right after the parameters section. >> >> Aaron Meurer >> >> On Tue, Jun 2, 2020 at 2:26 PM Mohit Shah <mohitsha...@gmail.com> wrote: >> >>> Thanks for the link, >>> Can you tell me where we can put the "error" and "return" section in the >>> docstring? >>> >>> On Tuesday, June 2, 2020 at 5:17:22 AM UTC+5:30, Aaron Meurer wrote: >>>> >>>> Here is the pull request that added the style guide, with lots of >>>> discussion https://github.com/sympy/sympy/pull/17715. There was also >>>> some discussion that happened on the mailing list >>>> https://groups.google.com/d/msg/sympy/JvcbdzbMN4g/981wq8B-BwAJ. >>>> >>>> Aaron Meurer >>>> >>>> On Mon, Jun 1, 2020 at 3:49 PM Mohit Shah <mohitsha...@gmail.com> >>>> wrote: >>>> >>>>> Sorry, But I didn't get you. >>>>> If we have to refer the older discussion, then can you provide link? >>>>> >>>>> On Tuesday, June 2, 2020 at 2:21:35 AM UTC+5:30, Aaron Meurer wrote: >>>>>> >>>>>> I believe the order of the sections in the style guide was decided as >>>>>> part of last year's GSoD project, so before we make any changes we >>>>>> should >>>>>> reference those discussions. >>>>>> >>>>>> Aaron Meurer >>>>>> >>>>>> On Mon, Jun 1, 2020 at 2:34 PM Mohit Shah <mohitsha...@gmail.com> >>>>>> wrote: >>>>>> >>>>>>> Hello everyone, >>>>>>> In Sympy Documentation >>>>>>> <https://docs.sympy.org/latest/documentation-style-guide.html>, >>>>>>> There is a section named "DocString sections". >>>>>>> I think there must be some changes. Like parameters must be before >>>>>>> Examples section and after parameter section, we can add a section for >>>>>>> returned value and then there should be example. >>>>>>> >>>>>>> [image: sympy.png] >>>>>>> Any suggestion will be appreciated. >>>>>>> Thanks. >>>>>>> >>>>>>> -- >>>>>>> You received this message because you are subscribed to the Google >>>>>>> Groups "sympy" group. >>>>>>> To unsubscribe from this group and stop receiving emails from it, >>>>>>> send an email to sy...@googlegroups.com. >>>>>>> To view this discussion on the web visit >>>>>>> https://groups.google.com/d/msgid/sympy/8559a780-caf1-4942-8ec8-23d8d811a84c%40googlegroups.com >>>>>>> >>>>>>> <https://groups.google.com/d/msgid/sympy/8559a780-caf1-4942-8ec8-23d8d811a84c%40googlegroups.com?utm_medium=email&utm_source=footer> >>>>>>> . >>>>>>> >>>>>> -- >>>>> You received this message because you are subscribed to the Google >>>>> Groups "sympy" group. >>>>> To unsubscribe from this group and stop receiving emails from it, send >>>>> an email to sy...@googlegroups.com. >>>>> To view this discussion on the web visit >>>>> https://groups.google.com/d/msgid/sympy/07e282a2-3903-4f9b-a4d5-17e0d7a48db7%40googlegroups.com >>>>> >>>>> <https://groups.google.com/d/msgid/sympy/07e282a2-3903-4f9b-a4d5-17e0d7a48db7%40googlegroups.com?utm_medium=email&utm_source=footer> >>>>> . >>>>> >>>> -- >>> You received this message because you are subscribed to the Google >>> Groups "sympy" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to sy...@googlegroups.com. >>> To view this discussion on the web visit >>> https://groups.google.com/d/msgid/sympy/09c51180-a3c6-47d7-9960-19ff10495e93%40googlegroups.com >>> >>> <https://groups.google.com/d/msgid/sympy/09c51180-a3c6-47d7-9960-19ff10495e93%40googlegroups.com?utm_medium=email&utm_source=footer> >>> . >>> >>
-- You received this message because you are subscribed to the Google Groups "sympy" group. To unsubscribe from this group and stop receiving emails from it, send an email to sympy+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/bcb9f556-9c5f-4a2e-8cc5-16986032914bo%40googlegroups.com.
