Skip to content

Commit

Permalink
Proof Review Guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
ceciliachan1979 committed Jan 21, 2024
1 parent 5efdbc1 commit 81c6936
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/blank.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ jobs:
Misc/Elliptic/Elliptic.tex
Misc/Automata/Automata.tex
Misc/Gaussian/Gaussian.tex
Misc/ProofReviewGuidelines/ProofReviewGuidelines.tex
Papers/GK/GK.tex
- name: Compile Chinese LaTeX documents
uses: xu-cheng/latex-action@v2
Expand Down Expand Up @@ -72,3 +73,4 @@ jobs:
Elliptic.pdf
Automata.pdf
Gaussian.pdf
ProofReviewGuidelines.pdf
32 changes: 32 additions & 0 deletions Misc/ProofReviewGuidelines/ProofReviewGuidelines.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
\documentclass{article}
\usepackage{hyperref}

\title{Proof review guidelines}
\author{Cecilia Chan}
\date{January 2024}

\begin{document}

\maketitle

\section*{Motivation}
The goal of this document is accumulate knowledge obtained from proof reviews. As we get more feedback, we should generalize the knowledge, make it into the check list below, so that we can check our own proofs.

\section*{Are all the symbols defined? What are their qualifications?}
For each symbol used in the proof, we should ask ourselves:
\begin{itemize}
\item Is it defined?
\item What are its qualifications?
\end{itemize}
Whenever we say for all, what is the domain?

\section*{Are the operations used allowed?}
For example, we cannot use "greatest" common divisor in an arbitrary Principal Ideal Domain. There isn't a ordering defined there.

\section*{Is it possible to misinterpret?}
Some common symbols can mean different things in different contexts. For example, 0 can be the additive identity or the zero vector, is it clear from the context?

\section*{Is it hard to read?}
Sometimes, we say "it is clear" or "it is obvious", it is really clear and obvious?

\end{document}

0 comments on commit 81c6936

Please sign in to comment.