JuliaDiff / JuliaDiff/BlueStyle

Guidelines on `export`

Open
#42 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
519
Forks
34
PR merge metrics
No merged PRs in 30d

Description

The BlueStyle conventions are great!

I was wondering if people would be interested in discussing adding some guidelines on when to use export and how that relates to the current section on using using and import. Additionally, it would be nice to clarify if how this guideline on module imports changes if at all in various contexts (REPL, scripts, packages, etc).

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with the README's current "Module imports" section and review how it discusses using and import. Compare the requested export guidance across REPLs, scripts, and packages, then document an agreed guideline and any context-specific differences.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.