Browse Source

remove fixed issues from documentation

Eren Yilmaz 6 years ago
parent
commit
3c83d511a7
3 changed files with 3 additions and 25 deletions
  1. 1 2
      doc/chapter/2architecture.tex
  2. 2 5
      doc/chapter/4progress.tex
  3. 0 18
      doc/chapter/appendix.tex

+ 1 - 2
doc/chapter/2architecture.tex

@@ -11,8 +11,7 @@ The following assumptions are made for the implementation of the node placement
 
 Regarding the last assumption, we found an example where for a disconnected graph the algorithm behaved incorrectly.
 Maybe we will get rid of this assumption later, see chapter~\ref{ch:progress}.
-We are currently investigating another example, where the algorithm behaves incorrectly for a connected graph.
-These two examples are included in the appendix (figures~\ref{fig:error_disconnected_img},~\ref{fig:error_connected_img},~\ref{fig:error_disconnected}, and~\ref{fig:error_connected}).
+This example is included in the appendix (figures~\ref{fig:error_disconnected_img} and~\ref{fig:error_disconnected}).
 
 
 \section{Overview}\label{sec:components}

+ 2 - 5
doc/chapter/4progress.tex

@@ -61,11 +61,8 @@ The following features are either planned (\planned), under construction (\progr
 \end{itemize}
 
 \section{Known Issues}\label{sec:knownIssues}
-The most important unsolved issues are listed here.
+Only the most important unsolved issues are listed here.
 For a complete list, see \url{https://koljastrohm-games.com:3000/GraphDrawer/NodeShuffler/issues}.
 \begin{itemize}
-    \item \sout{Our implementation does not behave correctly for very few graphs, see section ~\ref{sec:assumptions} and figures~\ref{fig:error_disconnected_img},~\ref{fig:error_connected_img},~\ref{fig:error_disconnected}, and~\ref{fig:error_connected}.}
-    We don't know what caused this problem but after a larger rewrite of the algorithm this is fixed, at least for connected graphs.
-    \item \sout{Swing is not thread-safe, but we are using multiple threads, so every now and then there are race conditions causing mostly \code{ArrayIndexOutOfBoundsException}s and \code{NullPointerException}s.}
-    Presumably fixed.
+    \item The most important issues were solved.
 \end{itemize}

+ 0 - 18
doc/chapter/appendix.tex

@@ -57,15 +57,6 @@
     \label{fig:error_disconnected_img}
 \end{figure}
 
-\begin{figure}[htp]
-    \centering
-    \includegraphics[width=0.33\linewidth]{img/error_connected}
-    \caption[Error caused by connected graph]{An illustration of the error that was caused by the graph displayed in figure~\ref{fig:error_connected}.
-    In the fourth layer the last two nodes were drawn at the same position.
-    The error has been fixed, see section~\ref{sec:knownIssues}.}
-    \label{fig:error_connected_img}
-\end{figure}
-
 \begin{figure}
     \begin{lstinputlisting}[language=json,emph={},basicstyle=\scriptsize\ttfamily,numberstyle=\tiny]{src/error_disconnected.json}
     \end{lstinputlisting}
@@ -73,12 +64,3 @@
     The error is illustrated in figure~\ref{fig:error_disconnected_img}.}
     \label{fig:error_disconnected}
 \end{figure}
-
-\begin{figure}
-    \begin{lstinputlisting}[language=json,emph={},basicstyle=\tiny\ttfamily,numberstyle=\tiny]{src/error_connected.json}
-    \end{lstinputlisting}
-    \caption[Connected graph causing an error]{Example graph where the node placement algorithm did not behave correctly, even though it is connected.
-    This was a problem with our implementation and has been fixed, see section~\ref{sec:knownIssues}.
-    The former error is illustrated in figure~\ref{fig:error_connected_img}.}
-    \label{fig:error_connected}
-\end{figure}