Re: [Tutor] Questions about the formatting of docstrings
On 27 Jul 2018 06:34, boB Stepp wrote: I am near the end of reading "Documenting Python Code: A Complete Guide" by James Mertz, found at https://realpython.com/documenting-python-code/ This has led me to a few questions: (1) The author claims that reStructuredText is the official Python documentation standard. Is this true? If yes, is this something I should be doing for my own projects? (2) How would type hints work with this reStructuredText formatting? In part of the author's reStructuredText example he has: [...] :param file_loc: The file location of the spreadsheet :type file_loc: str [...] Hi Bob, Have a look at numpydoc, which works with Sphinx. Numpydoc makes it much easier to read and write docstrings, while they can still be converted into nice looking docs, e.g html. See: https://codeandchaos.wordpress.com/2012/08/09/sphinx-and-numpydoc/ Albert-Jan ___ Tutor maillist - Tutor@python.org To unsubscribe or change subscription options: https://mail.python.org/mailman/listinfo/tutor
Re: [Tutor] how to change the command "string" on a tkinter Button?
On 27/07/2018 23:40, Alan Gauld via Tutor wrote: On 27/07/18 11:55, Shall, Sydney wrote: On 01/07/2018 11:19, Steven D'Aprano wrote: Even better would be to learn a form of VCS (version control system) such as Mercurial (hg) or git. Depending on the text editor you are using, it may have VCS integration available. Does Spyder have a VCS? Dunno, sorry... Could you list a few text-editors that do have VCS, please. It's not so much that they have a VCS but that they integrate with an existing VCS. So they will typically have menu options for checking in/out a file or locking/unlocking it. Typically you can configure which VCS they use from a list of common options, in some cases you can define the command line to use for each menu action. vim, emacs, Eclipse, Netbeans, VisualStudio etc all support VCS to varying degrees. But you still need to install and configure a VCS engine such as CVS, SVN, Hg or git etc. Thanks, that clarifies it for me. I shall learn to use GIT. Sydney ___ Tutor maillist - Tutor@python.org To unsubscribe or change subscription options: https://mail.python.org/mailman/listinfo/tutor
