Things To Do¶
Todo
set_property
throws warnings when parsed by Breathe so documentation isn’t generated for this function.
Breathe doesn’t easily support overloaded functions utilizing doxygenfunction::
, need to figure out
how to handle the manually declared overloaded functions.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/api/cpp/tracktable.core.PropertyMap.rst, line 10.)
Todo
compare
throws errors when parsed by Breathe so documentation isn’t generated for this function.
Breathe doesn’t easily support overloaded functions utilizing doxygenfunction::
, need to figure out
how to handle the manually declared overloaded functions.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/api/cpp/tracktable.core.PropertyValue.rst, line 10.)
Todo
jan_1_1900
, time_from_string
, time_to_string
, no_such_timestamp
, is_timestamp_valid
, truncate_fractional_seconds
, round_to_nearest_second
,
hours
, minutes
, seconds
, milliseconds
, microseconds
, days
, set_default_timestamp_output_format
,
default_timestamp_output_format
, set_default_timestamp_input_format
, default_timestamp_input_format
throw errors when parsed by Breathe so documentation isn’t generated for these functions.
The reason being, Breathe doesn’t easily support overloaded functions utilizing doxygenfunction::
, need to figure out
how to handle the manually declared overloaded functions.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/api/cpp/tracktable.core.Timestamp.rst, line 12.)
Todo
Until breathe implements a :no-index:
option to the doxygennamespace directive
we can’t provide a high level view of the Tracktable namespaces since they generate 60+
warnings about duplicate declarations of various functions/structs/classes etc.
Relevent Github issues can be found here: https://github.com/michaeljones/breathe/issues/378
and here: https://github.com/michaeljones/breathe/issues/405.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/api/cpp/tracktable.namespaces.rst, line 5.)
Todo
Define coding conventions for Python and C++
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/conventions.rst, line 83.)
Todo
When the “super-duper example data file” is created update this section with it’s location.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/data/acquire_data.rst, line 25.)
Todo
Create this section once Tracktable is able to intelligently generate trajectories between ports
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/data/data_generation.rst, line 153.)
Todo
Explore having a trajectory movie hosted on this page.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/examples/python/movies.rst, line 7.)
Todo
Figure out why our videos won’t play in the browser, maybe host gifs instead.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/examples/python/movies.rst, line 37.)
Todo
Figure out why our videos won’t play in the browser, maybe host gifs instead.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/examples/python/movies.rst, line 64.)
Todo
Figure out why our videos won’t play in the browser, maybe host gifs instead.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/examples/python/movies.rst, line 82.)
Todo
Figure out why our videos won’t play in the browser, maybe host gifs instead.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/examples/python/movies.rst, line 115.)
Todo
Write this section
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/user_guides/python/basic_operations.rst, line 32.)
Todo
This second code snippet is confusing.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/user_guides/python/basic_operations.rst, line 97.)
Todo
Modify this example to use max altitude / max speed as our features. Run on an example data set that has a mix of different classes of aircraft.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/user_guides/python/basic_operations.rst, line 522.)
Todo
Add tracktable.script_helpers.argument_groups to the documentation
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/user_guides/python/command_line.rst, line 169.)
Todo
Document response files in full
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/tracktable/checkouts/latest/tracktable-docs/Documentation/user_guides/python/command_line.rst, line 177.)