Skip to content

Commit 4506953

Browse files
committed
fix: Correct the date and improve internal formatting in slides/depc/depc5/index.qmd.
1 parent 5488f25 commit 4506953

File tree

1 file changed

+38
-7
lines changed

1 file changed

+38
-7
lines changed

slides/depc/depc5/index.qmd

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Project Critique for `Pyrefly`"
33
description: "Evaluating a project's documentation"
4-
date: "2025-12-03"
4+
date: "2025-12-01"
55
date-format: long
66
author: V Rieger, Brandon Thompson
77
execute:
@@ -19,46 +19,77 @@ format:
1919
---
2020

2121
## Overview of Pyrefly
22-
Pyrefly is a tool used mainly for type checking. Type checking is making sure that data, such as variables, are the types that they need to be. When using variables, some languages require you to specify a variables type when declaring it, like with Java. This is called a `statically typed language`. Python, however, does not require this specification, as it is a `dynamically typed language`. Dynamically typed languages have type checking occur at runtime.
22+
23+
Pyrefly is a tool used mainly for type checking. Type checking is making sure
24+
that data, such as variables, are the types that they need to be. When using
25+
variables, some languages require you to specify a variables type when declaring
26+
it, like with Java. This is called a `statically typed language`. Python,
27+
however, does not require this specification, as it is a `dynamically typed
28+
language`. Dynamically typed languages have type checking occur at runtime.
2329

2430
## Overview of Pyrefly
25-
Pyrefly is a way to catch errors before that happens. By using any type annotations that you may have set for a variable, it can tell you when you are assigning a value that doesn’t align with that. For example: declaring a variable as a string with a type annotation then trying to update it with an integer value will have Pyrefly flag that update to let you know there is a problem. This tool not only allows you to catch issues earlier as it works during development rather than having to wait to catch the error in runtime, but it also makes your code more readable by encouraging use of type annotations so you know more about a variable or function.
31+
32+
Pyrefly is a way to catch errors before that happens. By using any type
33+
annotations that you may have set for a variable, it can tell you when you are
34+
assigning a value that doesn’t align with that. For example: declaring a
35+
variable as a string with a type annotation then trying to update it with an
36+
integer value will have Pyrefly flag that update to let you know there is a
37+
problem. This tool not only allows you to catch issues earlier as it works
38+
during development rather than having to wait to catch the error in runtime, but
39+
it also makes your code more readable by encouraging use of type annotations so
40+
you know more about a variable or function.
2641

2742
## Overview of Pyrefly
28-
Pyrefly also acts as a language server which provides “language-specific features” to a code editor or IDE. Some of the features it provides include go to definition and find references. The former will allow you to click on where a function or class, for example, and bring you to where you defined it, and the latter does the reverse by allowing you to click on a definition and go to all of its uses.
43+
44+
Pyrefly also acts as a language server which provides “language-specific
45+
features” to a code editor or IDE. Some of the features it provides include go
46+
to definition and find references. The former will allow you to click on where a
47+
function or class, for example, and bring you to where you defined it, and the
48+
latter does the reverse by allowing you to click on a definition and go to all
49+
of its uses.
2950

3051
## Overview of Pyrefly's Documentation
52+
3153
- Covers what Pyrefly is and why type checking matters
3254
- Includes guides for installation, configuration, and installation
3355
- Includes sections for IDE setup, CLI commands, and FAQs
3456
- Provides examples showing how Pyrefly finds type errors
3557

3658
## Strengths of Pyrefly's Documentation
59+
3760
- Very clear and well organized
3861
- Has beginner and advanced topics
3962
- Good code examples
4063
- Easy to follow steps for setup
4164
- Is very transparent about its limitations due to it being in beta
4265

4366
## Weaknesses of Pyrefly's Documentation
67+
4468
- Some sections lack deep detail
4569
- Not many real-world examples or complex use cases
4670
- Lacks guidance for troubleshooting
4771
- Some features are still marked as unstable due to it being in beta
4872

4973
## Relation to Diataxis
74+
5075
Pyrefly's documentation includes:
5176

5277
- A section for learning about python typing - tutorial
5378
- Installation and configuration guides - how-to guide
5479
- A list of features - reference
5580

56-
The documentation could, however, include more explanations, further breaking down some of the information.
81+
The documentation could, however, include more explanations, further breaking
82+
down some of the information.
5783

5884
## Relation to Literate Programming
59-
Literate programming is about documenting your code to make it more human readable. Pyrefly does this by encouraging use of type annotations in your code. Having these type annotations can give you more information about your variables, functions, classes, etc. which makes them easier to understand.
85+
86+
Literate programming is about documenting your code to make it more human
87+
readable. Pyrefly does this by encouraging use of type annotations in your code.
88+
Having these type annotations can give you more information about your
89+
variables, functions, classes, etc. which makes them easier to understand.
6090

6191
## Suggestions for improvement
92+
6293
- Add real-world examples and more complex use cases
6394
- Create a troubleshooting section
64-
- Add Guidance for compatability for popular libraries
95+
- Add Guidance for compatability for popular libraries

0 commit comments

Comments
 (0)