Use Hash-symbol vs Triple-quotes Syntax for Commenting Python Code
Commenting Phython Code
I would
- use only the hash symbol '#' for commenting in Python
- leave code comments foramtted differntly as they should not interfere with Markdown.
Hash Symbol for everything that follows on the same line
In Python, you can comment your code using the hash symbol # (a.k.a. 'pound-sign'). Everything following the hash symbol on the same line is considered a comment and will be ignored by the interpreter. Here's an example:
# This is a single-line comment in Python
x = 1 # This is an inline comment
Multi-line comments can be created by
using the hash symbol at the beginning
of each line
Tripple-quotes for multi-line comments
One could also use triple quotes ''' or """ to create multi-line comments in Python by enclosing the comment text within them. However, this approach is typically reserved for docstrings, which are used to document functions, classes, and modules. Here's an example:
'''
This is a multi-line comment
using triple quotes.
'''
x = 5
def my_function():
"""
This is a docstring for the my_function.
It's used to document the purpose and usage of the function.
"""
pass
The tripple quote and Markdown
Using triple quotes for comments in Python code should not cause any issues with Markdown. Just like the pound signal Markdown uses for Headings does not. A markup language and a programming language serve distinct purposes. They are processed differently.
Jupyter Notebooks or GitHub READMEs
If you are writing Python code within a Markdown file (e.g., in a Jupyter Notebook or a GitHub README), you are typically using code blocks to separate the Python code from the Markdown text.
Codeblocks in Markdown are triple backticks, not triple quotes
Code blocks are created by enclosing the code in triple backticks ``` followed by the language identifier - in this case, python.
```python
'''
This is a multi-line comment
using triple quotes.
'''
x = 1
def my_function():
"""
This is a docstring for the my_function.
It's used to document the purpose and usage of the function.
"""
pass
Using triple quotes for comments in this way will not conflict with Markdown formatting, as the Markdown processor treats the content within code blocks as separate from the rest of the Markdown text.Optimize Netlify Build Minutes and DecapCMS by Skipping Unnecessary Builds
Optimize Netlify Build Minutes and DecapCMS by Skipping Unnecessary Builds
Displaying Both the Publication and Update Dates on Webpages
Showing both the update and the publish date on your blog / web page seems to be difficult for Search Engines and therefore it seems like only displaying “last updated” is the safer way. If your blog shows more than one date, you are probably confusing Google.
Localization: The "hreflang" Tag Accross Different Domains
John Mueller on how to use the hreflang tags across domains for the localization schemas: It doesn't matter if it's all on one domain or across multiple domains. It should just be one clear place per country and language.
DecapCMS Markdown Guide: Handling URLs with Parentheses for Text Fragment Highlighting
Are broken links in your DecapCMS Markdown articles giving you a headache? never let parentheses break your links again: handle text fragment highlighting in Markdown. No more parentheses-induced troubles in your Github articles built with Netlify!
Leveraging a Small JavaScript for a Quick Multilingual Strategy in Webflow
A button that appears when there is an alternate language defined for your content, making your cotent more relevant to your users experiences. Implementing a Dynamic Language Switcher Button with JavaScript
Interactive URL Copy Feature in Webflow Using Clean JavaScript and Clipboard API
An interactive URL copy feature in Webflow. Using clean JavaScript and the powerful Clipboard API, making it easier for visitors to share your pages. Because who doesn’t appreciate a great user experience?
An Extensive Dynamic Table of Contents Generator for Webflow CMS
Boost your Webflow Blog's readability and SEO with a dynamic Table of Contents (ToC) generator. It automatically creates a stylable, navigable ToC from your headings, and enhances user experience by highlighting the active section during scrolling.
Styling Our Auto-Generated ToC in Webflow
Creating or Changing Slugs in DecapCMS (formerly Netlify CMS)
Changing the URL Slug of your post in DecapCMS in config.yaml using the slug key and name key
Smooth Scrolling to the Next Section with JavaScript and [foo](#next) markdown syntax
When I write [[`foo`](#next)`](#next)` markdown syntax in my content I want the reader to jump to the next section, the next anchor, on my webpage.
Vimeo vs YouTube Embed for your Website
Consider this when you decide between YouTube or Vimeo for Website embeds
Editorial Workflow in Decap CMs (formerly Netlify CMS)
README for ChatGPT and How to Write the Best Prompts
When answering prompts, does it help ChatGPT to be more specific and precise if you give it a set of definitions upfront?
Use Hash-symbol vs Triple-quotes Syntax for Commenting Python Code
Consider this when you choose the syntax for commenting code in Python
Dynamically Generated ToC with Webflow CMS
Generating ToC’s based on h2 and h3 headings of a rich text CMS element with active states in a sticky Table of Contents
Dynamic Social Media Share Buttons for Webflow CMS Blogposts
Add a Twitter button and a share on LinkedIn to your blogposts with sharing content generated from Webflow CMS
Calculate Read Time from Webflow CMS
Calculated a read time from Webflow CMS and add to your blog template.
Add Copy-able Code Blocks to Webflow CMS
Uses highlight.js and custom code to add code blocks where you can copy the code to rich text element of Webflow CMS