chapel-lang/chapel

Enable chpldoc extern flag?

Open

#6,026 opened on Apr 14, 2017

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Chapel (446 forks)auto 404
area: Compilerarea: Docsarea: Toolsgood first issuehelp wanted / stealtype: Designtype: Unimplemented Feature

Repository metrics

Stars
 (2,010 stars)
PR merge metrics
 (PR metrics pending)

Description

Open question: would we want to give the ability for a chpldoc user to avoid outputting extern declarations via a flag? The support is mostly present today and theoretically only involves uncommenting this line to complete but we aren't sure of the utility.

This was considered because extern functions are often used for under-the-hood code that is generally not something we want to expose to clients of the particular module, and so might fall under the same category as private functions.

Compile command: chpldoc externTest.doc.chpl

Associated Future Test(s): test/chpldoc/compflags/extern/externTest.doc.chpl

Contributor guide

Research direction
Uncomment the line in docsDriver.cpp and run the associated test to verify functionality.
Tech stack
None
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
GitChapelchpldoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80