https://github.com/juliapluto/methodurl.jl

Return the remote repository URL of any Julia method
https://github.com/juliapluto/methodurl.jl

Last synced: about 1 month ago
JSON representation

Return the remote repository URL of any Julia method

• Host: GitHub
• URL: https://github.com/juliapluto/methodurl.jl
• Owner: JuliaPluto
• License: mit
• Created: 2024-10-21T18:36:08.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-18T15:47:18.000Z (about 2 months ago)
• Last Synced: 2024-11-18T17:12:37.647Z (about 2 months ago)
• Language: Julia
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MethodURL

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://adrhill.github.io/MethodURL.jl/stable/)

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://adrhill.github.io/MethodURL.jl/dev/)

[![Build Status](https://github.com/adrhill/MethodURL.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/adrhill/MethodURL.jl/actions/workflows/CI.yml?query=branch%3Amain)

[![Coverage](https://codecov.io/gh/adrhill/MethodURL.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/adrhill/MethodURL.jl)

[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)

This package gives a URL to github/gitlab/etc where a method from a package is defined. 

# Example

```julia

julia> import MethodURL, Example

julia> MethodURL.url(

          methods(Example.hello)[1]

       )

1-element Vector{String}:

 "https://github.com/JuliaLang/Example.jl/blob/v0.5.5/src/Example.jl#L9"

```

# Context

Julia has a function `Base.url(::Method)`, but this function only works for methods from Base. It worked on non-Base methods in previous Julia versions, but this functionality disappeared (see https://github.com/JuliaLang/julia/issues/47709). This package aims to reimplement that functionality for modern Julia versions.

# Work in progress

This package is still being worked on. When it is finished, we want to use it in Pluto.jl stack frames, see https://github.com/fonsp/Pluto.jl/pull/2813