mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-07-07 20:06:36 +02:00
Documentation
- Updated developer docs.
This commit is contained in:
parent
db37b0d4ed
commit
2897005e25
3 changed files with 6 additions and 22 deletions
25
DEVELOPER
25
DEVELOPER
|
@ -112,9 +112,6 @@ New Code Needs
|
||||||
data file, as found by 'task diag'. This should check to see if there is
|
data file, as found by 'task diag'. This should check to see if there is
|
||||||
a suitable UUID generator installed. This should also be careful to
|
a suitable UUID generator installed. This should also be careful to
|
||||||
properly handle recurring tasks.
|
properly handle recurring tasks.
|
||||||
- Need an external implementation equivalent to, or better than the 'shadow
|
|
||||||
file' feature. Simply because shadow file capability *can* be implemented
|
|
||||||
outside the core code, we want to make it be that way.
|
|
||||||
- Take a look at:
|
- Take a look at:
|
||||||
|
|
||||||
https://bug.tasktools.org/browse/EX
|
https://bug.tasktools.org/browse/EX
|
||||||
|
@ -123,21 +120,6 @@ New Code Needs
|
||||||
lie outside of the core product, and will be implemented as external scripts
|
lie outside of the core product, and will be implemented as external scripts
|
||||||
by anyone who wishes to participate.
|
by anyone who wishes to participate.
|
||||||
|
|
||||||
Documentation Needed
|
|
||||||
Documentation takes many forms, and we are trying to combine all documentation
|
|
||||||
into one repository, to facilitate sharing and centralize review. This
|
|
||||||
includeѕ:
|
|
||||||
|
|
||||||
- Man pages
|
|
||||||
- Reference PDF
|
|
||||||
- Wiki replacement
|
|
||||||
- Tutorials
|
|
||||||
- Cookbook
|
|
||||||
|
|
||||||
This is all in the new https://git.tasktools.org/projects/ST/repos/tw.org
|
|
||||||
repository, where all the documents are sourced as markdown. We welcome
|
|
||||||
everyone with writing skills to help us improve this critical resource.
|
|
||||||
|
|
||||||
Unit Tests Needed
|
Unit Tests Needed
|
||||||
There are always more unit tests needed. More specifically, better unit tests
|
There are always more unit tests needed. More specifically, better unit tests
|
||||||
are always needed. The convention is that there are four types of unit test:
|
are always needed. The convention is that there are four types of unit test:
|
||||||
|
@ -157,8 +139,9 @@ Unit Tests Needed
|
||||||
these kind of tests be extensive and thorough, because the software depends
|
these kind of tests be extensive and thorough, because the software depends
|
||||||
on this code the most.
|
on this code the most.
|
||||||
|
|
||||||
The tests are mainly written in Perl, and all use TAP. Here is how to get the
|
The tests are mainly written in Perl, and all use TAP. We want them all to be
|
||||||
code and run the test suite:
|
eventually replaced by Python. Here is how to get the code and run the test
|
||||||
|
suite:
|
||||||
git clone https://git.tasktools.org/scm/tm/task.git
|
git clone https://git.tasktools.org/scm/tm/task.git
|
||||||
cd task.git
|
cd task.git
|
||||||
git checkout 2.4.0
|
git checkout 2.4.0
|
||||||
|
@ -190,8 +173,6 @@ Unit Tests Needed
|
||||||
delete, done, and list commands. We need unit tests that prove that basic
|
delete, done, and list commands. We need unit tests that prove that basic
|
||||||
functionality is working, and the file containing them should be called
|
functionality is working, and the file containing them should be called
|
||||||
basic.t.
|
basic.t.
|
||||||
- None of the current unit tests remove the 'extensions' directory, and they
|
|
||||||
all should.
|
|
||||||
- Test propagation of modifications to recurring tasks.
|
- Test propagation of modifications to recurring tasks.
|
||||||
- Test regex support.
|
- Test regex support.
|
||||||
- Need unit tests for each bug in the issue list, if suitable.
|
- Need unit tests for each bug in the issue list, if suitable.
|
||||||
|
|
1
NEWS
1
NEWS
|
@ -23,6 +23,7 @@ New configuration options in taskwarrior 2.4.0
|
||||||
Newly deprecated features in taskwarrior 2.4.0
|
Newly deprecated features in taskwarrior 2.4.0
|
||||||
|
|
||||||
- The alias '_query' is deprecated.
|
- The alias '_query' is deprecated.
|
||||||
|
- The 'shadow file' feature is deprecated.
|
||||||
|
|
||||||
Removed features in 2.4.0
|
Removed features in 2.4.0
|
||||||
|
|
||||||
|
|
|
@ -1057,6 +1057,8 @@ preferences, but it is important that you carefully consider any modifications.
|
||||||
|
|
||||||
.SS SHADOW FILE
|
.SS SHADOW FILE
|
||||||
|
|
||||||
|
Note, this feature is deprecated in 2.4.0.
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.B
|
.B
|
||||||
shadow.file=$HOME/.task/shadow.txt
|
shadow.file=$HOME/.task/shadow.txt
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue