From 3c10db04b989f8652a0cca94e9cfc1c6e6a9a31d Mon Sep 17 00:00:00 2001 From: "Joshua A. Anderson" Date: Thu, 9 May 2024 16:48:06 -0400 Subject: [PATCH] More TODO notes. --- .github/CODEOWNERS | 1 + DESIGN.md | 6 ++++++ README.md | 5 +++++ doc/book.toml | 2 ++ src/workflow.rs | 3 --- 5 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..3c6c1aa --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* joaander diff --git a/DESIGN.md b/DESIGN.md index 5c4eafd..75c9b24 100644 --- a/DESIGN.md +++ b/DESIGN.md @@ -298,3 +298,9 @@ status may take a long time, so it should display a progress bar. - **whole group**: A **submission group** that is identical to the **group** found without applying the additional submission filters. - **workspace**: The location on the file system that contains **directories**. + +# TODO: Pull request template +# TODO: Issue templates? +# TODO: Dependabot configuration +# TODO: readthedocs builds +# TODO: logo diff --git a/README.md b/README.md index e87696c..daf5f02 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # Row +[![GitHub Actions](https://github.com/glotzerlab/row/actions/workflows/test.yaml/badge.svg?branch=trunk)](https://github.com/glotzerlab/row/actions/workflows/test.yaml) +[![Read the Docs](https://img.shields.io/readthedocs/row/latest.svg)](https://row.readthedocs.io/) +[![Contributors](https://img.shields.io/github/contributors-anon/glotzerlab/row.svg?style=flat)](https://row.readthedocs.io/en/latest/contributors.html) +[![License](https://img.shields.io/badge/license-BSD--3--Clause-green.svg)](LICENSE) + Row is a command line tool that helps you manage workflows on HPC resources. Define **actions** in a workflow configuration file that apply to **groups** of **directories** in your **workspace**. **Submit** actions to your HPC **scheduler**. Row tracks which diff --git a/doc/book.toml b/doc/book.toml index 33da2a9..71d751f 100644 --- a/doc/book.toml +++ b/doc/book.toml @@ -14,3 +14,5 @@ create-missing = false # You also need to install https://github.com/Michael-F-Bryan/mdbook-linkcheck. # [output.linkcheck] # follow-web-links = true + +# TODO: Add page footer. diff --git a/src/workflow.rs b/src/workflow.rs index 037bfdd..17ef623 100644 --- a/src/workflow.rs +++ b/src/workflow.rs @@ -239,9 +239,6 @@ impl ResourceCost { impl fmt::Display for ResourceCost { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let mut formatter = Formatter::new(); - // TODO: choose decimals more intelligently here. - // Currently: 4,499,000 will print as 4M, but 449,900 will print as 450K. - // It would be nice if we always kept 3 sig figs, giving 4.50M in the first case. formatter.with_decimals(0); formatter.with_separator("");