JuliaLang/julia

Bug in HTML output of method tables

Open

#5,239 opened on Dec 27, 2013

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Julia (5,773 forks)batch import
display and printinghelp wanted

Repository metrics

Stars
 (48,709 stars)
PR merge metrics
 (Avg merge 20d 6h) (157 merged PRs in 30d)

Description

It looks like < and > aren't being escaped properly in writemime(::IO, ::MIME("text/html"), ::MethodTable):

From IJulia qtconsole:

methods(ndims)
Out[11]: 
6 methods for generic function ndims:
ndims(x::Number) at number.jl:10
ndims{T(::Type{T) at number.jl:11
ndims{T,N}(s::SubArray{T,N,A) at subarray.jl:180
ndims{T,n}(::AbstractArray{T,n}) at abstractarray.jl:19
ndims{T,n}(::Type{AbstractArray{T,n}}) at abstractarray.jl:20
ndims{T(::Type{T) at abstractarray.jl:21

From the terminal:

julia> methods(ndims)
#6 methods for generic function "ndims":
ndims(x::Number) at number.jl:10
ndims{T<:Number}(::Type{T<:Number}) at number.jl:11
ndims{T,N}(s::SubArray{T,N,A<:AbstractArray{T,N},I<:(Union(Range{Int64},Range1{Int64},Int64)...,)}) at subarray.jl:180
ndims{T,n}(::AbstractArray{T,n}) at abstractarray.jl:19
ndims{T,n}(::Type{AbstractArray{T,n}}) at abstractarray.jl:20
ndims{T<:AbstractArray{T,N}}(::Type{T<:AbstractArray{T,N}}) at abstractarray.jl:21

Contributor guide

Research direction
Inspect the `writemime` method for `MethodTable` in Julia's source, specifically the HTML output path, and identify where `<` and `>` are not being escaped properly.
Tech stack
None
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Julia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55