Skip to content

Commit

Permalink
clancy
Browse files Browse the repository at this point in the history
  • Loading branch information
yegor256 committed Apr 10, 2024
1 parent 4474661 commit e31c9e0
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 5 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/bibcop.yml
@@ -0,0 +1,32 @@
# The MIT License (MIT)
#
# Copyright (c) 2021-2024 Yegor Bugayenko
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
---
name: bibcop
'on':
push:
pull_request:
jobs:
bibcop:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@master
- uses: yegor256/bibcop-action@master
11 changes: 10 additions & 1 deletion main.bib
Expand Up @@ -16,4 +16,13 @@ @book{zobel2004writing
author={Zobel, Justin},
year={2004},
publisher={{Springer}}
}
}

@misc{clancy2020,
author = {Clancy, Lisa},
title={{How to Write a Figure Caption}},
howpublished = {\url{https://www.internationalscienceediting.com/how-to-write-a-figure-caption/}},
note = {[Online; accessed 10-04-2024]},
year = {2020},
}

20 changes: 16 additions & 4 deletions main.tex
@@ -1,7 +1,6 @@
\documentclass[11pt,nonacm]{acmart}
\usepackage{silence}
\WarningFilter{acmart}{\vspace should only be used to provide space above/below}
\settopmatter{printfolios=false,printccs=false,printacmref=false}
\makeatletter\let\@authorsaddresses\@empty\makeatother
\usepackage[T1]{fontenc}
\usepackage{href-ul}
Expand All @@ -24,6 +23,7 @@
\usepackage{bibcop}
\pagenumbering{gobble}
\raggedbottom
\tolerance=2000
\setlength{\parindent}{0pt}
\setlength{\columnsep}{32pt}
\setlength{\parskip}{6pt}
Expand All @@ -34,7 +34,13 @@
\newcommand{\hint}{\refstepcounter{hint}\S\arabic{hint}: }

\begin{abstract}
This is a humble attempt to summarize most typical mistakes we make while writing academic papers in \LaTeX{} and most important recommendations. Each suggestion or a mistake takes a short paragraph of description right here and also may suggest looking into a more detailed explanation in some other online resource. We recommend, before submitting your paper to a conference or a journal, go through this list of mistakes and make sure none of them are present in your paper.
This is a humble attempt to summarize most typical mistakes we
make while writing academic papers in \LaTeX{} and most important
recommendations. Each suggestion or a mistake takes a short paragraph of
description right here and also may suggest looking into a more detailed
explanation in some other online resource. We recommend, before submitting
your paper to a conference or a journal, go through this list of mistakes and
make sure none of them are present in your paper.
\end{abstract}

\begin{document}
Expand Down Expand Up @@ -106,10 +112,16 @@ \section{Code Snippets}
\section{Figures and Tables}

\hint
Don't force positioning in figures and tables, like \ff{\char`\\begin\{table\}[h]}. Instead, just wrap them in \ff{\char`\\begin\{table\}}.
Don't force positioning in figures and tables, like
\ff{\char`\\begin\{table\}[h]}. Instead, just wrap them
in \ff{\char`\\begin\{table\}}.

\hint
Make sure the explanation you place into \ff{\char`\\caption} is detailed enough to let your reader understand the content without searching the text; see how it's done in \href{https://arxiv.org/abs/2203.07814}{this paper}.
As recommended by \citet{clancy2020}, make sure
the explanation you place into \ff{\char`\\caption} is
detailed enough to let your reader understand the content without
searching the text; see how it's done in
\href{https://arxiv.org/abs/2203.07814}{this paper}.

\hint
Prefer a list over a table and a table over a graph.
Expand Down

0 comments on commit e31c9e0

Please sign in to comment.