josephwright / josephwright/beamer

[doc] Complete list of theorem envs is incomplete

Open
#641 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
1.7k
Forks
164
PR merge metrics
No merged PRs in 30d

Description

As reported by https://tex.stackexchange.com/q/569670, predefined theorem environments lemma, problem, solution and proof are missing from the "complete list". I hesitate to provide a PR because I cannot fix the following incomplete German part, for I cannot speak German.

https://github.com/josephwright/beamer/blob/0a94777966e0231bee06e1db98d880ea751d04d6/doc/beamerug-localstructure.tex#L518-L521

For better readability:

\subsection{Theorem Environments}
\label{section-theorems}

The \beamer\ class predefines several environments, like |theorem| or |definition| or |proof|, that you can use to typeset things like, well, theorems, definitions, or proofs.

The complete list is the following: |theorem|, |corollary|, |definition|, |definitions|, |fact|, |example|, and |examples|.

The following German block environments are also predefined: |Problem|, |Loesung|, |Definition|, |Satz|, |Beweis|, |Folgerung|, |Lemma|, |Fakt|, |Beispiel|, and |Beispiele|.

Corresponding source:
https://github.com/josephwright/beamer/blob/0a94777966e0231bee06e1db98d880ea751d04d6/base/beamerbasetheorems.sty#L109-L151

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with doc/beamerug-localstructure.tex at the linked Theorem Environments section and compare its complete list with the predefined environments in base/beamerbasetheorems.sty. Check the German block as well; the documentation is done when both lists accurately reflect the corresponding source definitions.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.