golang/go

x/mod/modfile: document which fields in a parsed modfile may be nil

Open

#60,898 opened on Jun 20, 2023

View on GitHub
 (1 comment) (1 reaction) (1 assignee)Go (19,008 forks)batch import
DocumentationNeedsInvestigationhelp wantedmodules

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We've had several crashes in gopls related to modfile.File.Module being nil.

On the other hand, we have a bunch of code checking if modfile.File.Module.Syntax is nil -- is that possible if modfile.File.Module is non-nil?

It would be nice if the modfile API documented which fields may be nil.

CC @bcmills @adonovan

Contributor guide

Research direction
Inspect the modfile package source code to identify which fields may be nil in a parsed modfile and update the documentation comments accordingly.
Tech stack
go
Domain
developer experiencetooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70