Search
- Filter Results
- Location
- Classification
- Include attachments
- https://eng.libretexts.org/Bookshelves/Computer_Science/Programming_Languages/Python_Programming_(OpenStax)/01%3A_Statements/1.07%3A_CommentsThis page outlines learning objectives for writing effective comments and docstrings in Python. It emphasizes the purpose and formatting of comments, prioritizing clarity and structure for code readab...This page outlines learning objectives for writing effective comments and docstrings in Python. It emphasizes the purpose and formatting of comments, prioritizing clarity and structure for code readability. Additionally, it discusses the role of docstrings in program documentation, providing guidelines for effective use. It also highlights the importance of separating code sections with blank lines and crafting informative comments.
- https://eng.libretexts.org/Courses/Oxnard_College/Matlab_and_Octave_Programming_for_STEM_Applications_(Smith)/02%3A_MATLAB_Octave_Scripts/2.11%3A_Script_DocumentationEvery script should provide documentation, which is a comment that explains what the script does and what its requirements are. % Computes a numerical approximation of the nth Fibonacci number. % Prec...Every script should provide documentation, which is a comment that explains what the script does and what its requirements are. % Computes a numerical approximation of the nth Fibonacci number. % Precondition: you must assign a value to n before running this script. % Postcondition: the result is stored in ans. If there is a comment at the beginning of a script, MATLAB assumes it’s the documentation for the script.
- https://eng.libretexts.org/Bookshelves/Data_Science/Principles_of_Data_Science_(OpenStax)/10%3A_Reporting_Results/10.07%3A_Critical_ThinkingThis page outlines strategies for technical writers to enhance data science report accessibility for both experts and non-specialists, especially executives. Key points include the significance of ver...This page outlines strategies for technical writers to enhance data science report accessibility for both experts and non-specialists, especially executives. Key points include the significance of version control, effective visual aids, clear documentation of methodologies, communication of assumptions, interpretation of statistical measures, and the importance of sensitivity analyses.
- https://eng.libretexts.org/Bookshelves/Computer_Science/Programming_Languages/Python_Programming_(OpenStax)/16%3A_Answer_Key/16.06%3A_Chapter_7This page offers an overview of Python modules, covering fundamentals like importing, top-level code, and the use of the help function. It discusses defining functions within modules, the importance o...This page offers an overview of Python modules, covering fundamentals like importing, top-level code, and the use of the help function. It discusses defining functions within modules, the importance of the __name__ variable, and handling imports and name errors. Documentation organization, including docstrings, standard libraries such as tkinter and MoviePy, and hexadecimal color representation are also addressed.
- https://eng.libretexts.org/Bookshelves/Computer_Science/Programming_Languages/Python_Programming_(OpenStax)/07%3A_Modules/7.06%3A_Chapter_SummaryThis page covers organizing Python programs through the use of multiple .py files (modules) and the import system. It emphasizes the significance of the if __name__ == "__main__" statement for executi...This page covers organizing Python programs through the use of multiple .py files (modules) and the import system. It emphasizes the significance of the if __name__ == "__main__" statement for execution control. The help() function is introduced for accessing module documentation, and there are over 200 built-in modules available, along with many third-party options. The chapter includes examples of importing modules and accessing their documentation.
