Migration Away from MicroPython.org to GitHub?

General discussions and questions abound development of code with MicroPython that is not hardware specific.
Target audience: MicroPython Users.
Post Reply
MMliam
Posts: 121
Joined: Mon May 07, 2018 1:08 pm

Migration Away from MicroPython.org to GitHub?

Post by MMliam » Tue Aug 30, 2022 1:47 pm

Why is there an apparent migration of discussions away from the MicroPython.org site to GitHub. MicroPython.org has superior tools, particularly when is comes to inserting code snippets:

Code: Select all

For clarity,
this format is
far superior
to anything
offered on GitHub

User avatar
scruss
Posts: 359
Joined: Sat Aug 12, 2017 2:27 pm
Location: Toronto, Canada
Contact:

Re: Migration Away from MicroPython.org to GitHub?

Post by scruss » Tue Aug 30, 2022 2:07 pm

There's an existing thread here: Migration to GitHub Discussions

Github's ``` (triple backtick) notation for included code is okay once you get used to it.

MMliam
Posts: 121
Joined: Mon May 07, 2018 1:08 pm

Re: Migration Away from MicroPython.org to GitHub?

Post by MMliam » Tue Aug 30, 2022 2:21 pm

I had tried the "triple backtick" before posting my question.
The problem I saw, was it merged all instructions on a single line with only a space in between. Then, when I added a CRLF it put an empty line between each instruction. Is that normal?
For example after inserting CR-LF's:
https://github.com/orgs/micropython/discussions/9128
Last edited by MMliam on Tue Aug 30, 2022 2:26 pm, edited 1 time in total.

User avatar
jimmo
Posts: 2754
Joined: Tue Aug 08, 2017 1:57 am
Location: Sydney, Australia
Contact:

Re: Migration Away from MicroPython.org to GitHub?

Post by jimmo » Tue Aug 30, 2022 2:23 pm

MMliam wrote:
Tue Aug 30, 2022 2:21 pm
I had tried the "triple backtick" before posting my question.
The problem I saw, was it merged all instructions on a single line with only a space in between. Then, when I added a CRLF it put an empty line between each instruction. Is that normal?
For example:
https://github.com/orgs/micropython/discussions/9128
It looks like you only used a single backtick

`foo
bar`

you need to use triple backtick for a code block

```
foo
bar
```

See https://docs.github.com/en/get-started/ ... oting-code

User avatar
jimmo
Posts: 2754
Joined: Tue Aug 08, 2017 1:57 am
Location: Sydney, Australia
Contact:

Re: Migration Away from MicroPython.org to GitHub?

Post by jimmo » Tue Aug 30, 2022 2:28 pm

In GitHub, you can also select your code and click the <> button in the editing toolbar (like you can on phpbb) to automatically do the right thing. If it's a inline selection it will use single-backtick, if it's multi-line selection it will triple-backtick.
MMliam wrote:
Tue Aug 30, 2022 1:47 pm
MicroPython.org has superior tools, particularly when is comes to inserting code snippets:
In my opinion GitHub's formatting tools are vastly superior -- not only does it support inline snippets, but it also supports syntax highlighting. It's also Markdown which is becoming the de-facto standard everywhere.

MMliam
Posts: 121
Joined: Mon May 07, 2018 1:08 pm

Re: Migration Away from MicroPython.org to GitHub?

Post by MMliam » Tue Aug 30, 2022 2:31 pm

I created this "Test Discussion" to demonstrate.

https://github.com/micropython/micropyt ... sions/9154

The original source had a CR-LF between each line, but they are ignored in the standard format.

DeaD_EyE
Posts: 19
Joined: Sun Jul 17, 2022 12:57 pm
Contact:

Re: Migration Away from MicroPython.org to GitHub?

Post by DeaD_EyE » Tue Aug 30, 2022 4:39 pm

The original source had a CR-LF between each line, but they are ignored in the standard format.
This is normal. Many Forums are doing this + indentation is also lost.
Put Code into Code-Tags:

Code: Select all

```CODE```
You should read this: https://docs.github.com/en/get-started/ ... ing-syntax

Jackli
Posts: 80
Joined: Thu Apr 29, 2021 9:11 am

Re: Migration Away from MicroPython.org to GitHub?

Post by Jackli » Thu May 25, 2023 8:20 am

GitHub discussions have more features for posts and replies. Emoticon replies, accepted answers, thread replies, etc.
GitHub discusses using more familiar Markdown syntax to write posts, especially code snippets (which also support syntax highlighting).

Post Reply