[Docs] Add docs on breaking change

This commit is contained in:
2025-09-26 12:07:48 +02:00
parent bfaec9ba8c
commit 565b600ef0
3 changed files with 10 additions and 1 deletions

View File

@@ -5,6 +5,9 @@
This repository contains a collection of LaTeX files, helping you get started with LaTeX quickly.
Breaking change in the current version: the time complexity commands now require the math environment. You may use the following vim-regex to fix issues in your code:
`:%s/\\text{\\tc\([olt]\){\(.*\)}}/\\tc\1{\2}/g` (execute first) and `:%s/ \\tc\([olt]\){\(.*)}\([, .\n]\)/ \$\\tc\1{\2}\$\3/g`
# Getting started
See the docs [here](https://git.janishutz.com/janishutz/latex/src/branch/main/docs/docs.pdf) to get started.

View File

@@ -26,6 +26,12 @@ This set of \LaTeX files is designed to give you a good looking, pre-configured
It has some configuration options already, but more are to come soon. If you have any suggestions as to what should be added, don't hesitate to open a support ticket at \url{https://support.janishutz.com?a=add} or contacting me via email to \texttt{development@janishutz.com}.
\begin{Large}
\shade{red}{Breaking Changes}: The timecomplexity commands have been updated to require math environment. You can use the following regex to fix them
\verb|:%s/\\text{\\tc\([olt]\){\(.*\)}}/\\tc\1{\2}/g| (execute first) and \verb|:%s/ \\tc\([olt]\){\(.*)}\([, .\n]\)/ \$\\tc\1{\2}\$\3/g|
\end{Large}
\section{Installation}
You can install these helper files by downloading this repo and storing it to any location on your PC, remembering where that location is.

View File

@@ -16,7 +16,7 @@
\newcommand{\tc}[1]{\timecomplexity $\Theta\left(#1\right)$}
\newcommand{\tct}[1]{\Theta\left(#1\right)}
\newcommand{\tco}[1]{\mathcal{O}\left(#1\right)}
\newcommand{\tcl}[1]{\Omega\left(#1\right)$}
\newcommand{\tcl}[1]{\Omega\left(#1\right)}
\newcommand{\tR}{\text{R}}
\newcommand{\tC}{\text{C}}
\newcommand{\tN}{\text{N}}