Skip to content

Commit

Permalink
fixd docs hopefully the last time
Browse files Browse the repository at this point in the history
  • Loading branch information
eohne committed Aug 7, 2024
1 parent 3570ccb commit e5977dc
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions docs/src/Prices.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,20 @@ For a few stocks yahoo finance will return `nothing` for specific timestamps in

For performance reasons and easier integration with `TimeSeries.jl` these `nothing` values are returned as `NaN`s. Some other packages like python's `yahooquery` do not return these datapoints at all. We decided to return them to indicate a break in the series and to indicate that Yahoo Finance thinks it should have price information for the specific timestamp but does not have any.

````@docs
get_prices
````
<!-- ````@docs
get_prices(::AbstractString;::AbstractString,::AbstractString,::Any,::Any,::Any,::Any,::Any,::Any,::Any,::Any)
```` -->

## Optional Sink Argument (Julia 1.9+)

For Julia versions 1.9+ optional sink arguments can be given as the first argument.
If you want to return a TimeArray from TimeSeries.jl execute `get_prices(TimeArray,syombol,...)`. If you want to return a TSFrame from TSFrames.jl execute `get_prices(TSFrame,syombol,...)`.

<!-- ````@docs
get_prices(::Type{TSFrame},::String;::AbstractString,::AbstractString,::Any, ::Any,::Any,::Any,::Any,::Any,::Any,::Any)
get_prices(::Type{TimeArray},::String;:AbstractString,::AbstractString,::Any, ::Any,::Any,::Any,::Any,::Any,::Any,::Any)
```` -->


You can also covert from the OrderedDict to these by using the following function:

```@docs
sink_prices_to(::Type{TimeArray},::OrderedDict{String,Any})
sink_prices_to(::Type{TSFrame},::OrderedDict{String,Any})
```
```
## get_prices

````@docs
get_prices
````

0 comments on commit e5977dc

Please sign in to comment.