Improved documentation.

[?]
CrEcTsRjb1hHQjHuumqRfqdbVV4X58iLEubi4noaDPFa
Jul 21, 2021, 7:57 AM
BB2T6X3XK3Y4JFOMBGKTFVL6BZ5NOGBTPSCK4ADRSZQLQKQHESLAC

Dependencies

  • [2] 5B2HBV3J Completed first try at ts Json data-structure.
  • [3] SPSFTMLR Completed loading ts_data from specification.
  • [4] GQVS55HI Finished generate_ts_spec() function.
  • [5] 2SABVMY3 Finished into_json() functionality.
  • [6] K4CH53V4 Added GPL2 license, included missing source files.
  • [7] 2CCG6KUP Redo time-series spec.
  • [8] TSY4YBBZ Changed ts Spec datastructures to new format.
  • [9] TTR5IFSG Working on building generic TSSpec.
  • [10] SAHJYVNB Removed checking functionality.
  • [11] XI5ALEH6 Take advantage of keytree FromStr functionality.
  • [12] YJXKWWM6 Added max() min() n GraphicJson and cleaned up serialization

Change contents

  • replacement in src/ts.rs at line 4
    [2.32][3.0:20](),[3.7612][3.0:20](),[3.30][3.30:46](),[3.46][3.0:14](),[3.14][3.7664:7677](),[3.46][3.7664:7677](),[3.7664][3.7664:7677]()
    use std::convert::{
    TryInto,
    };
    use std::fmt;
    use std::fs;
    [2.32]
    [3.314]
    use std::convert::{ TryInto };
    use std::{fmt, fs};
  • replacement in src/ts.rs at line 8
    [3.7678][2.33:80]()
    use serde::{
    Serialize,
    Serializer,
    };
    [3.7678]
    [2.80]
    use serde::{ Serialize, Serializer };
  • replacement in src/ts.rs at line 12
    [3.7725][3.1024:1068](),[3.7843][3.7843:7846](),[3.7846][3.111:173](),[3.173][3.7904:7907](),[3.7904][3.7904:7907](),[3.7907][2.114:159]()
    use keytree::{
    KeyTree,
    KeyTreeRef,
    };
    use keytree::serialize::{
    KeyTreeString,
    IntoKeyTree,
    };
    use time_series::{
    RegularTimeSeries,
    };
    [3.7725]
    [3.7907]
    use keytree::{ KeyTree, KeyTreeRef };
    use keytree::serialize::{ KeyTreeString, IntoKeyTree };
    use time_series::{ RegularTimeSeries };
  • replacement in src/ts.rs at line 16
    [3.7908][3.5253:5266](),[3.291][3.5266:5280](),[3.5266][3.5266:5280](),[3.1092][3.338:353](),[3.353][3.0:17](),[3.1092][3.0:17](),[3.17][3.5280:5294](),[3.1092][3.5280:5294](),[3.5280][3.5280:5294](),[3.5294][3.292:312](),[3.312][2.160:176](),[2.176][3.5294:5297](),[3.312][3.5294:5297](),[3.1113][3.5294:5297](),[3.5294][3.5294:5297]()
    use crate::{
    DataType,
    DateRange,
    MonthlyDate,
    SeriesId,
    SeriesMetaData,
    SeriesSpec,
    };
    [3.7908]
    [3.1114]
    use crate::{ DataType, DateRange, MonthlyDate, SeriesId, SeriesMetaData, SeriesSpec };
  • edit in src/ts.rs at line 19
    [3.1136]
    [3.18]
    // Default height in pixels of a graphic.
  • edit in src/ts.rs at line 22
    [3.2014]
    [2.177]
    /// Top level Javascript-facing data-structure, that is loaded into memory by the server, and acts
    /// as an immutable datastore for time-series web-pages.
  • edit in src/ts.rs at line 27
    [2.268]
    [2.268]
    /// The values in `Json` that are served one per web-page.
  • edit in src/ts.rs at line 35
    [2.415]
    [2.415]
    /// A component of `Json` that is a single data series. Series are referenced by graphics through an
    /// index, so that each series can be used multiple times, without being downloaded multiple times.
  • edit in src/ts.rs at line 43
    [2.579][2.579:580](),[2.580][3.4815:4915](),[3.1508][3.4815:4915](),[3.5988][3.4815:4915]()
    // === Time-series Specification ==================================================================
  • edit in src/ts.rs at line 44
    [3.4916]
    [2.581]
    /// The top-level Fred-facing time-series specification. By convention, the file 'ts_spec.keytree'
    /// can be deserialized into this type using the `KeyTree` library.
  • replacement in src/ts.rs at line 72
    [2.606][2.606:611]()
    [2.606]
    [2.611]
    // This function is responsible for converting `Spec` into `Json`. The iteration is simple, but
    // the building of `Json` is a little complex. This is the point where Fred-facing data-structures
    // meet Javascript-facing client data-structures, and hence the incongruence.
  • edit in src/ts.rs at line 350
    [3.3670][3.3052:3154](),[3.3052][3.3052:3154]()
    // === Transforms ==================================================================================