From c525d5ad9e52e233b1724c061d1ff2755aa38a25 Mon Sep 17 00:00:00 2001 From: Gustav Eek Date: Tue, 28 Mar 2023 08:32:23 +0200 Subject: [PATCH] Todo. Initial on tracking progress --- TODO | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 TODO diff --git a/TODO b/TODO new file mode 100644 index 0000000..eac5390 --- /dev/null +++ b/TODO @@ -0,0 +1,51 @@ +# -*- mode: org -*- eval: (setq org-adapt-indentation nil) -*- +#+title: Maintenance Notes and TODO:s +#+author: Gustav Eek +#+startup: indent content +# +# Copyright (C) 2023 Gustav Eek +# SPDX-License-Identifier: GPL-3.0-or-later + +* Refactor +** TODO Document all functions +:LOGBOOK: +- State "TODO" from [2023-03-28 tis 08:05] +:END: + +Provide documentation according to the Rust book, [[file:///home/gustav/.local/share/rustup/toolchains/stable-x86_64-unknown-linux-gnu/share/doc/rust/html/book/ch14-02-publishing-to-crates-io.html][14.2. Publishing a Crate to +Crates.io]]: + + - [ ] Per every file + - [ ] Per every constant + - [ ] Per every function + +** TODO Divide code into files +:LOGBOOK: +- State "TODO" from [2023-03-28 tis 08:24] +:END: + +Most of code should probably be a library, /lib/, according to the Rust book +[[file:///home/gustav/.local/share/rustup/toolchains/stable-x86_64-unknown-linux-gnu/share/doc/rust/html/book/ch12-03-improving-error-handling-and-modularity.html][12.3. Refactoring to Improve Modularity and Error Handling]] and [[file:///home/gustav/.local/share/rustup/toolchains/stable-x86_64-unknown-linux-gnu/share/doc/rust/html/book/ch12-04-testing-the-librarys-functionality.html][12.4. Developing +the Library’s Functionality with Test Driven Development]]. + +* Features + +** TODO Test command line input and output +:LOGBOOK: +- State "TODO" from [2023-03-28 tis 08:21] +:END: + +Though quite narrow, the command line interaction need testing. Investigate what +possibilities that comes with Rust. Otherwise, investigate Karlens project. + +* Bugs +* Documentation +** TODO Describe more in CLI help +:LOGBOOK: +- State "TODO" from [2023-03-28 tis 08:01] +:END: + +Make a better description in the command line =--help= print: + + - [ ] Describe the functions (cfr. /README/). + - [ ] Provide levels to skewness and distribion options -- 2.39.2