Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…kwarrior into issue3240
  • Loading branch information
djmitche committed Jan 20, 2024
2 parents f6e69f5 + b515f87 commit 816caa1
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 17 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ jobs:
# MacOS tests do not run in Docker, and use the actions-rs Rust installaction
tests-macos-12:
name: tests (Mac OS 12.latest)
if: false # see #3242
runs-on: macos-latest
steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -33,6 +34,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
tests-macos-13:
name: tests (Mac OS 13.latest)
if: false # see #3242
runs-on: macos-13
steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -115,4 +117,4 @@ jobs:
run: docker-compose run test-$CONTAINER
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CONTAINER: ${{ matrix.dockerfile }}
CONTAINER: ${{ matrix.dockerfile }}
5 changes: 3 additions & 2 deletions taskchampion/docs/src/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,11 @@ The following keys, and key formats, are defined:
* `modified` - the time of the last modification of this task
* `start` - the most recent time at which this task was started (a task with no `start` key is not active)
* `end` - if present, the time at which this task was completed or deleted (note that this key may not agree with `status`: it may be present for a pending task, or absent for a deleted or completed task)
* `tag_<tag>` - indicates this task has tag `<tag>` (value is an empty string)
* `tag_<tag>` - indicates this task has tag `<tag>` (value is ignored)
* `wait` - indicates the time before which this task should be hidden, as it is not actionable
* `entry` - the time at which the task was created
* `annotation_<timestamp>` - value is an annotation created at the given time
* `annotation_<timestamp>` - value is an annotation created at the given time; for example, `annotation_1693329505`.
* `dep_<uuid>` - indicates this task depends on another task identified by `<uuid>`; the value is ignored; for example, `dep_8c4fed9c-c0d2-40c2-936d-36fc44e084a0`

Note that while TaskChampion recognizes "recurring" as a status, it does not implement recurrence directly.

Expand Down
15 changes: 8 additions & 7 deletions taskchampion/lib/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,19 @@ ffizz_header::snippet! {
///
/// # Overview
///
/// This library defines two major types used to interact with the API, that map directly to Rust
/// This library defines four major types used to interact with the API, that map directly to Rust
/// types.
///
/// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html * TCTask
/// - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html * TCServer - see
/// https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html * TCWorkingSet - see
/// https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html
/// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html
/// * TCTask - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html
/// * TCServer - see https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html
/// * TCWorkingSet - see https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html
///
/// It also defines a few utility types:
///
/// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings. *
/// TC…List - a list of objects represented as a C array * see below for the remainder
/// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings.
/// * TC…List - a list of objects represented as a C array
/// * see below for the remainder
///
/// # Safety
///
Expand Down
15 changes: 8 additions & 7 deletions taskchampion/lib/taskchampion.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,19 @@
//
// # Overview
//
// This library defines two major types used to interact with the API, that map directly to Rust
// This library defines four major types used to interact with the API, that map directly to Rust
// types.
//
// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html * TCTask
// - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html * TCServer - see
// https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html * TCWorkingSet - see
// https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html
// * TCReplica - see https://docs.rs/taskchampion/latest/taskchampion/struct.Replica.html
// * TCTask - see https://docs.rs/taskchampion/latest/taskchampion/struct.Task.html
// * TCServer - see https://docs.rs/taskchampion/latest/taskchampion/trait.Server.html
// * TCWorkingSet - see https://docs.rs/taskchampion/latest/taskchampion/struct.WorkingSet.html
//
// It also defines a few utility types:
//
// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings. *
// TC…List - a list of objects represented as a C array * see below for the remainder
// * TCString - a wrapper around both C (NUL-terminated) and Rust (always utf-8) strings.
// * TC…List - a list of objects represented as a C array
// * see below for the remainder
//
// # Safety
//
Expand Down

0 comments on commit 816caa1

Please sign in to comment.