I'm glad you've stated this - too many people equate documentation to "docstrings" or embedded or inline docs with the code. - Ashraf Miah - Medium

These flow charts can be included in the external documentation for your code and should provide step-by-step instructions on how a function works, what it should …

How to Write Good Code Documentation for Data Scientists

Madison Hunter

Jun 15, 2022

--

I'm glad you've stated this - too many people equate documentation to "docstrings" or embedded or inline docs with the code.

Ashraf Miah

Written by Ashraf Miah

Data Scientist and Chartered Aeronautical Engineer (MEng CEng EUR ING MRAeS) with over 15 years experience in the Aerospace, Defence and Rail Industry.

Recommended from Medium

The ChatGPT Hype Is Over — Now Watch How Google Will Kill ChatGPT.

AL Anany

The ChatGPT Hype Is Over — Now Watch How Google Will Kill ChatGPT.

It never happens instantly. The business game is longer than you know.

6 min readSep 1

--

280

10 Seconds That Ended My 20 Year Marriage

Unbecoming

10 Seconds That Ended My 20 Year Marriage

It’s August in Northern Virginia, hot and humid. I still haven’t showered from my morning trail run. I’m wearing my stay-at-home mom…

4 min readFeb 16, 2022

--

944

Lists

Staff Picks

454 stories296 saves

Stories to Help You Level-Up at Work

19 stories223 saves

Self-Improvement 101

20 stories600 saves

Productivity 101

20 stories555 saves

The End of the Subscription Era is Coming

Nick Hilton

The End of the Subscription Era is Coming

You’re overpaying for your porn (and journalism)

10 min readAug 30

--

204

An AI-generated image of a man radiating vibrant energy and calm after his morning routine

Neeramitra Reddy
in
Better Humans

The Most Powerful Morning Routine I’ve Found After 3+ Years of Experimenting

A realistic, science-based, customizable, and aggressively self-tested morning system

18 min read5 days ago

--

37

Advice From a Software Engineer With 8 Years of Experience

Benoit Ruiz
in
Better Programming

Advice From a Software Engineer With 8 Years of Experience

Practical tips for those who want to advance in their careers

22 min readMar 20

--

184

Why Japanese Websites Look So Different

Mirijam Missbichler

Why Japanese Websites Look So Different

& how to analyze design choices without jumping to conclusions

8 min readMay 1

--

194

See more recommendations

Help
Status
Writers
Blog
Careers
Privacy
Terms
About
Text to speech
Teams