swiftlang/swift

[SR-339] SILParser needs grammar documentation

Open

#42,961 opened on Dec 22, 2015

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Swift (10,719 forks)batch import
compilergood first issueimprovementnfc

Repository metrics

Stars
 (69,989 stars)
PR merge metrics
 (Avg merge 8d 17h) (510 merged PRs in 30d)

Description
Previous ID SR-339
Radar None
Original Reporter @gottesmm
Type Improvement
Votes 0
Component/s Compiler
Labels Improvement, StarterBug
Assignee None
Priority Medium

md5: 5302b54da94f1f9b716db2124c316e90

Issue Description:

The SILParser is a recursive descent parser. In general when one implements a recursive descent parser, one should above the routine that does the various parts of the parsing show the grammar being parsed. SILParser has inconsistently done this. I would go through all of the methods and see which are missing this documentation and fix the documentation.

Contributor guide

Research direction
Review the SILParser methods in the Swift compiler source code. Identify which methods lack grammar documentation comments at the top. Add comments describing the grammar rules being parsed by each method.
Tech stack
swift
Domain
documentation
Issue type
Documentation
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitSwift
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90