You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is there a preferred way to address users? Especially for tutorials where we want to give instructions to the reader. Guidance on commenting and explaining code: explanation in markdown above the code cell? below? general explanation in markdown only and implementation details as comments within the code? glossary terms, how do we know if a term should be explained in the notebook or in the gossary, or in both even. other potentially controversial topics?
It doesn't need to be very extensive and it can even be mostly links to other pages, but I think it will make both writing and reviewing notebooks easier
The text was updated successfully, but these errors were encountered:
adding onto this, if the author wants to discuss their approach, thought process or opinions on using certain libraries in the description markdown cells, should there be a guideline for that?
it does sound strange to put a rule on someone expressing their thoughts while demonstrating something in a notebook but I was wondering about it anyway, especially if we are updating the notebooks to use new dependencies but the author has talked about their approaches using the older dependencies used in that notebook.
Is there a preferred way to address users? Especially for tutorials where we want to give instructions to the reader. Guidance on commenting and explaining code: explanation in markdown above the code cell? below? general explanation in markdown only and implementation details as comments within the code? glossary terms, how do we know if a term should be explained in the notebook or in the gossary, or in both even. other potentially controversial topics?
cc @martinacantaro
It doesn't need to be very extensive and it can even be mostly links to other pages, but I think it will make both writing and reviewing notebooks easier
The text was updated successfully, but these errors were encountered: