search

JuliaPlots / AbstractPlotting.jl

An abstract interface for plotting libraries, part of the Makie ecosystem.
http://makie.juliaplots.org/dev
MIT License
85 stars 65 forks source link

Missing docstrings #148

Closed asinghvi17 closed 5 years ago

asinghvi17 commented 5 years ago 
┌ Warning: 160 docstrings potentially missing:
│
│     AbstractPlotting.recordframe! :: Tuple{VideoStream}
│     AbstractPlotting.volumeslices! :: Tuple
│     AbstractPlotting.safe_off :: Tuple{Observables.AbstractObservable,Any}
│     AbstractPlotting.streamlines! :: Tuple
│     AbstractPlotting.reasonable_resolution :: Tuple{}
│     AbstractPlotting.to_color :: Tuple{Any}
│     AbstractPlotting.mesh! :: Tuple
│     AbstractPlotting.annotations! :: Tuple
│     AbstractPlotting.interpolated_getindex :: Union{Tuple{T}, Tuple{AbstractArray{T,N} where N,AbstractFloat}, Tuple{AbstractArray{T,N} where N,AbstractFloat,Any}} where T
│     AbstractPlotting.Automatic
│     AbstractPlotting.scatterlines :: Tuple
│     AbstractPlotting.must_update :: Tuple{}
│     AbstractPlotting.elconvert :: Union{Tuple{N}, Tuple{T2}, Tuple{T1}, Tuple{Type{T1},AbstractArray{T2,N}}} where N where T2 where T1
│     AbstractPlotting.@get_attribute :: Tuple{Any,Any}
│     AbstractPlotting.default_printer :: Tuple{Any}
│     AbstractPlotting.wireframe :: Tuple
│     AbstractPlotting.fit_factor :: Union{Tuple{N}, Tuple{Any,Tuple{Vararg{Any,N}}}} where N
│     AbstractPlotting.available_gradients :: Tuple{}
│     AbstractPlotting.lookat :: Union{Tuple{T}, Tuple{Vec{3,T},Vec{3,T},Vec{3,T}}} where T
│     AbstractPlotting.colorswatch :: Union{Tuple{}, Tuple{Any}}
│     AbstractPlotting.available_marker_symbols :: Tuple{}
│     AbstractPlotting.replay_events :: Tuple{Scene,String}
│     AbstractPlotting.mergekeys :: Union{Tuple{N}, Tuple{Tuple{Vararg{Symbol,N}},Attributes,Attributes}} where N
│     AbstractPlotting.colorlegend :: Tuple
│     AbstractPlotting.annotations :: Tuple
│     AbstractPlotting.detach! :: Tuple{Combined}
│     AbstractPlotting.plottype :: Union{Tuple{T}, Tuple{Type{#s154} where #s154<:(Combined{Any,T} where T),Type{#s153} where #s153<:(Combined{T,T1} where T1)}} where T
│     AbstractPlotting.plottype :: Tuple
│     AbstractPlotting.fit_ratio :: Tuple{Any,Any}
│     AbstractPlotting.contour3d! :: Tuple
│     AbstractPlotting.to_type :: Tuple{Function}
│     AbstractPlotting.cam2d :: Tuple{Scene}
│     AbstractPlotting.fit_factor_stretch :: Union{Tuple{N}, Tuple{Any,Tuple{Vararg{Any,N}}}} where N
│     AbstractPlotting.text! :: Tuple
│     AbstractPlotting.FRect :: NTuple{4,Any}
│     AbstractPlotting.step! :: Tuple{Stepper}
│     AbstractPlotting.Mouse
│     AbstractPlotting.argument_names :: Union{Tuple{P}, Tuple{P}} where P<:AbstractPlot
│     FileIO.save :: Union{Tuple{F}, Tuple{File{F},Scene}} where F
│     FileIO.save :: Tuple{String,VideoStream}
│     AbstractPlotting.series :: Tuple
│     AbstractPlotting.update_limits! :: Union{Tuple{Scene,GeometryTypes.HyperRectangle}, Tuple{Scene,GeometryTypes.HyperRectangle,Any}}
│     AbstractPlotting.update_limits! :: Tuple{Scene}
│     AbstractPlotting.barplot! :: Tuple
│     AbstractPlotting.wireframe! :: Tuple
│     AbstractPlotting.linesegments! :: Tuple
│     AbstractPlotting.ColorSampler
│     AbstractPlotting.broadcast_foreach :: Tuple{Any,Vararg{Any,N} where N}
│     AbstractPlotting.mouseposition :: Union{Tuple{}, Tuple{Any}}
│     AbstractPlotting.arrows! :: Tuple
│     AbstractPlotting.surface! :: Tuple
│     AbstractPlotting.lines! :: Tuple
│     AbstractPlotting.colorlegend! :: Tuple
│     AbstractPlotting.plot! :: Tuple{Union{AbstractScene, AbstractPlotting.ScenePlot},Union{Type{Any}, Type{#s156} where #s156<:AbstractPlot},Attributes,Vararg{Any,N} where N}
│     AbstractPlotting.plot! :: Tuple{Wireframe{...}}
│     AbstractPlotting.update! :: Tuple{Scene}
│     AbstractPlotting.arc! :: Tuple
│     AbstractPlotting.close2square :: Tuple{Real}
│     AbstractPlotting.perspectiveprojection :: Union{Tuple{T}, Tuple{GeometryTypes.SimpleRectangle,T,T,T}} where T
│     AbstractPlotting.perspectiveprojection :: Union{Tuple{T}, NTuple{4,T}} where T
│     AbstractPlotting.apply_convert! :: Tuple{Any,Attributes,Tuple}
│     AbstractPlotting.apply_convert! :: Union{Tuple{S}, Tuple{Any,Attributes,PlotSpec{S}}} where S
│     AbstractPlotting.@extractvalue :: Tuple{Any,Any}
│     AbstractPlotting.calculated_attributes! :: Union{Tuple{T}, Tuple{T}} where T
│     AbstractPlotting.calculated_attributes! :: Tuple{Any,Any}
│     AbstractPlotting.contour3d :: Tuple
│     AbstractPlotting.band! :: Tuple
│     AbstractPlotting.force_update! :: Tuple{}
│     AbstractPlotting.series! :: Tuple
│     AbstractPlotting.to_spritemarker :: Tuple{AbstractArray{T,1} where T}
│     AbstractPlotting.to_spritemarker :: Tuple{Array{#s155,2} where #s155<:AbstractFloat}
│     AbstractPlotting.to_spritemarker :: Tuple{AbstractArray{#s155,2} where #s155<:ColorTypes.Colorant}
│     AbstractPlotting.to_spritemarker :: Tuple{Char}
│     AbstractPlotting.to_spritemarker :: Tuple{Symbol}
│     AbstractPlotting.to_spritemarker :: Tuple{Type{#s155} where #s155<:(GeometryTypes.HyperSphere{2,T} where T)}
│     AbstractPlotting.to_spritemarker :: Tuple{Type{#s155} where #s155<:GeometryTypes.SimpleRectangle}
│     AbstractPlotting.to_spritemarker :: Tuple{GeometryTypes.HyperSphere{2,T} where T}
│     AbstractPlotting.button :: Tuple
│     AbstractPlotting.to_colormap :: Tuple{Any}
│     AbstractPlotting.raw_boundingbox :: Tuple{Union{Image{...}, MeshScatter{...}, Scatter{...}, Mesh{...}, LineSegments{...}, Lines{...}, Surface{...}, Volume{...}, Heatmap{...}, Text{...}} where Arg}
│     AbstractPlotting.flatten_combined :: Union{Tuple{Array{T,1} where T}, Tuple{Array{T,1} where T,Any}}
│     AbstractPlotting.IRect :: Tuple{Any,Any,Union{Tuple{Vararg{T,N}}, StaticArrays.StaticArray{Tuple{N},T,1}} where T where N}
│     AbstractPlotting.IRect :: Tuple{NamedTuple{(:x, :y),T} where T<:Tuple,NamedTuple{(:width, :height),T} where T<:Tuple}
│     AbstractPlotting.IRect :: NTuple{4,Any}
│     AbstractPlotting.IRect :: Tuple{Union{Tuple{Vararg{T,N}}, StaticArrays.StaticArray{Tuple{N},T,1}} where T where N,Any,Any}
│     AbstractPlotting.IRect :: Tuple{Union{Tuple{Vararg{T,N}}, StaticArrays.StaticArray{Tuple{N},T,1}} where T where N,Union{Tuple{Vararg{T,N}}, StaticArrays.StaticArray{Tuple{N},T,1}} where T where N}
│     AbstractPlotting.IRect3D
│     AbstractPlotting.volume! :: Tuple
│     AbstractPlotting.mergekeys! :: Union{Tuple{N}, Tuple{Tuple{Vararg{Symbol,N}},Attributes,Attributes}} where N
│     AbstractPlotting.legend :: Tuple
│     AbstractPlotting.resampled_colors :: Tuple{Any,Integer}
│     AbstractPlotting.convert_attribute :: Tuple{Union{String, Symbol},AbstractPlotting.Key{:algorithm}}
│     AbstractPlotting.convert_attribute :: Tuple{Tuple{Symbol,Symbol},AbstractPlotting.Key{:align}}
│     AbstractPlotting.convert_attribute :: Tuple{Quaternion,AbstractPlotting.Key{:rotation}}
│     AbstractPlotting.convert_attribute :: Tuple{Union{Tuple, Pair},AbstractPlotting.Key{:colormap}}
│     AbstractPlotting.convert_attribute :: Union{Tuple{Union{String, Symbol},AbstractPlotting.Key{:colormap}}, Tuple{Union{String, Symbol},AbstractPlotting.Key{:colormap},Integer}}
│     AbstractPlotting.convert_attribute :: Tuple{AbstractArray{T,1} where T,AbstractPlotting.Key{:colormap}}
│     AbstractPlotting.convert_attribute :: Tuple{Any,AbstractPlotting.Key{:algorithm}}
│     AbstractPlotting.convert_attribute :: Tuple{AbstractArray{T,1} where T,AbstractPlotting.Key{:linestyle}}
│     AbstractPlotting.convert_attribute :: Tuple{Symbol,AbstractPlotting.Key{:linestyle}}
│     AbstractPlotting.convert_attribute :: Tuple{Union{String, Symbol},AbstractPlotting.Key{:font}}
│     AbstractPlotting.used_attributes :: Tuple{Any,Vararg{Any,N} where N}
│     AbstractPlotting.image! :: Tuple
│     AbstractPlotting.update_cam! :: Tuple{Union{AbstractScene, AbstractPlotting.ScenePlot},Any}
│     AbstractPlotting.update_cam! :: Tuple{Union{AbstractScene, AbstractPlotting.ScenePlot}}
│     AbstractPlotting.primary_resolution :: Tuple{}
│     AbstractPlotting.available_backends
│     AbstractPlotting.Rect3D
│     AbstractPlotting.Reverse
│     AbstractPlotting.move_from_touch :: Union{Tuple{T}, Tuple{N}, Tuple{GeometryTypes.GeometryPrimitive{N,T},GeometryTypes.GeometryPrimitive{N,T} where T,Vec{N,T} where T}} where T where N
│     AbstractPlotting.dont_touch :: Union{Tuple{N}, Tuple{GeometryTypes.GeometryPrimitive{N,T} where T,GeometryTypes.GeometryPrimitive{N,T} where T,Vec{N,T} where T}} where N
│     AbstractPlotting.notify! :: Tuple{Observables.Observable}
│     AbstractPlotting.mouse_selection
│     AbstractPlotting.onpick
│     AbstractPlotting.replace_automatic! :: Tuple{Any,Any,Any}
│     AbstractPlotting.scatter! :: Tuple
│     AbstractPlotting.PlotList
│     AbstractPlotting.FRect3D
│     AbstractPlotting.to_func :: Union{Tuple{Type{#s155} where #s155<:AbstractPlot{F}}, Tuple{F}} where F
│     AbstractPlotting.volumeslices :: Tuple
│     AbstractPlotting.automatic
│     AbstractPlotting.IRect2D
│     AbstractPlotting.atomic_limits :: Union{Tuple{Union{MeshScatter{...}, Scatter{...}, Text{...}, Mesh{...}, LineSegments{...}, Lines{...}, Surface{...}, Volume{...}, Heatmap{...}, Image{...}} where #s155<:Tuple{Arg1}}, Tuple{Arg1}} where Arg1
│     Observables.on :: Tuple{Any,Camera,Vararg{Observables.Observable,N} where N}
│     AbstractPlotting.hovered_scene :: Tuple{}
│     AbstractPlotting.showgradients :: Tuple{AbstractArray{Symbol,1}}
│     AbstractPlotting.Plot :: Union{Tuple{Vararg{Any,N}}, Tuple{N}} where N
│     AbstractPlotting.arc :: Tuple
│     AbstractPlotting.VideoStream :: Tuple{Scene}
│     AbstractPlotting.default_plot_signatures :: Tuple{Any,Any,Any}
│     AbstractPlotting.title :: Tuple{Any,Any}
│     AbstractPlotting.to_string :: Tuple{Function}
│     AbstractPlotting.ispressed :: Tuple{Union{AbstractScene, AbstractPlotting.ScenePlot},Union{Tuple, Array{T,1} where T}}
│     AbstractPlotting.Billboard
│     AbstractPlotting.showlibrary :: Tuple{Symbol}
│     AbstractPlotting.legend! :: Tuple
│     AbstractPlotting.PlotSpec
│     AbstractPlotting.streamlines :: Tuple
│     AbstractPlotting.resample :: Tuple{AbstractArray{T,1} where T,Integer}
│     AbstractPlotting.plots_from_camera :: Tuple{Scene}
│     AbstractPlotting.@extract :: Tuple{Any,Any}
│     AbstractPlotting.meshscatter! :: Tuple
│     AbstractPlotting.sig_printer :: Tuple{Real}
│     AbstractPlotting.pick
│     AbstractPlotting.current_scene :: Tuple{}
│     AbstractPlotting.poly! :: Tuple
│     AbstractPlotting.button! :: Tuple
│     AbstractPlotting.heatmap! :: Tuple
│     AbstractPlotting.map_once :: Tuple{Any,Observables.Observable,Vararg{Observables.Observable,N} where N}
│     AbstractPlotting.record_events :: Tuple{Any,Scene,String}
│     AbstractPlotting.frustum :: Union{Tuple{T}, NTuple{6,T}} where T
│     AbstractPlotting.scatterlines! :: Tuple
│     AbstractPlotting.print_rec :: Union{Tuple{IO,Any}, Tuple{IO,Any,Int64}}
│     AbstractPlotting.select_rectangle :: Tuple{Any}
│     AbstractPlotting.zoom! :: Tuple{Any,Any,Any}
│     AbstractPlotting.slider! :: Tuple
│     AbstractPlotting.contour! :: Tuple
│     AbstractPlotting.fill_between! :: Tuple{Any,Any,Any}
│     AbstractPlotting.@recipe :: Tuple{Any,Symbol,Vararg{Symbol,N} where N}
│     AbstractPlotting.from_dict :: Union{Tuple{T}, Tuple{Type{T},Any}} where T
└ @ Documenter.DocChecks ~/.julia/packages/Documenter/msPrq/src/DocChecks.jl:62
asinghvi17 commented 5 years ago

Duplicate...submitted 2 by accident