Code Formatter tutorial notebooks

[Dcosthephalump]

For the code formatter extension, this issue details the process for creating a code formatter notebook. Because there are several different code formatters that are compatible with Python, this tutorial will stick with Python formatters. Future work could add tutorials on formatters for other languages. Knowing that, the strategy for this is:

• CodeFormatter: look through the black formatter style guide and see what things are formatted which way and why [2 hrs] #59
  • experiment with these things using each formatter and take notes in a cell inside an experimental notebook
  • extract basic features like single quotes versus double quotes for
• CodeFormatter: make notebooks
  • CodeFormatter: explain basic features in an introductory notebook using experimental notebook [2 hrs] #60
    • Identify basic features
    • Develop examples
  • CodeFormatter: come up with a realistic-ish example that utilizes style guides to make it cleaner [2 hrs] #61
    • consider using a notebook online and unformatting it?
• CodeFormatter: update environment.yml to include pip dependencies (code-formatter extension and formatters) [30 minutes] #62

Ideally, the example notebooks from this could be used to create material for #43 and solve much of nbdime here.

[Dcosthephalump]

I was trying to figure out a problem with my installation of the black code formatter. It was not following through with the promised output from:

in:

def foo():

print("All the newlines above me should be deleted!")

if condition:

print("No newline above me!")

print("There is a newline above me, and that's OK!")

class Point:

x: int
y: int

out:

def foo():
print("All the newlines above me should be deleted!")

if condition:
print("No newline above me!")

print("There is a newline above me, and that's OK!")

class Point:
x: int
y: int

It turns out, this is for version 23.3.0 of black. I had installed the blue code formatter as version 0.9.1, which relied on version 22.1.0 of black. This broke the expected output.

[Dcosthephalump]

CodeFormatter has to be installed with the pip package manager. The same is true for the code formatters