Archive

Bonnes pratiques pour partager du code dans le forum

ChristelleMariais

Pour faciliter la lecture et les réponses à vos questions lorsque vous partagez du code (Python par exemple) voici plusieurs manières de faire :

1- Utiliser le bouton image

Pour montrer du code et le conserver tel quel, vous pouvez utiliser dans la barre d’édition de votre message le bouton image .

  • Vous écrivez votre texte normalement, éventuellement par copier-coller, en faisant quand même attention à ce que le texte soit correct ;
  • vous sélectionnez la zone qui correspond à du code (ça marche aussi avec du texte qui n’est pas dans des lignes séparées mais au sein d’un message. Par exemple : le terme fact est un symbole de code et mérite d’être présenté comme tel) ;
  • vous cliquez sur le bouton image - sur mac je peux utiliser le raccourci clavier ⌘-⇧-C et sous windows Ctrl+Maj+C.

Cela encadre automatiquement le texte sélectionné avec des quotes `

2- Encadrer le code avec 3 quotes ```

Par exemple (l’indication du langage n’est pas obligatoire) :
```python
def fact(n):
if n <= 1:
return 1
else:
return n * (n-1)
```

qui donne

def fact(n):
    if n <= 1:
        return 1
    else:
        return n * (n-1)

3- Décaler le texte de 4 espaces vers la droite

On peut également mettre du code sous forme de texte brut en décalant simplement le texte de 4 espaces vers la droite (mais dans ce cas on n’a pas la coloration que l’on obtient avec la méthode précédente)

def fact(n):
    if n <= 1:
        return 1
    else:
        return n * (n-1)

4- Partager votre notebook Jupyter

Si vous souhaitez partager du code écrit dans un notebook Jupyter voici une procédure simple et efficace :

  • dans le menu supérieur de votre notebook cliquez sur ‘File -> Share Static Version’
  • vous obtenez alors un lien que vous pouvez copier dans votre message sur le forum de discussion et les autres participants pourront cliquer sur ce lien pour voir le contenu de votre notebook :+1:

A noter

Sachez enfin qu’en markdown (le langage utilisé pour le formatage des messages que vous écrivez), une ligne qui commence par un dièse # (suivi d’un espace) correspond à un titre de niveau 1, ## correspond à un titre de niveau 2, etc.

Par exemple

hello 1

hello 2

hello 3

Intéressant pour structurer un long message mais embêtant quand il s’agit de partager du code Python :wink:

ThierryParmentelat