Which functions go where?

Open
  • Is something wrong?
#4 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
julia
Domain
data

Research direction

Start by comparing the functions in Graphs.jl with the planned split in GraphsBase.jl. Determine which functions form the user-overridden interface, which are basic core functionality, and which are higher-level algorithms. Done means the interface and core are placed in GraphsBase.jl while algorithms remain in Graphs.jl.

Written by the indexing model from the issue text.

Description

question

Splitting out GraphsBase.jl means deciding which functions

  1. Have to be overridden by users (the "interface")
  2. Rely on the interface while remaining reasonably basic (the "core")
  3. Rely on the interface and core while adding more sophisticated functionality (the "algorithms")

The interface and core will go in GraphsBase.jl, the algorithms will remain in Graphs.jl.

Dominant language
Julia
Stars
11
Forks
2
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from JuliaGraphs/GraphsBase.jl

All issues in JuliaGraphs/GraphsBase.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.