janestreet / janestreet/spawn

How to resolve "prog" in PATH?

Open
#5 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
69
Forks
21
PR merge metrics
No merged PRs in 30d

Description

The documentation in `spawn.mli` says:

> [prog] is not searched in [PATH]. It is up to the caller to do the path resolution before calling this function.

However, it does not explain how the caller is expected to do that.

There are perhaps many ways to achieve in OCaml, nevertheless I propose that the documentation briefly mentions which method the library author(s) had in mind, and/or which method they are actually using when faced with that task.

Even better would be an actual helper function to resolve that, e.g.

```ocaml
spawn ... ~prog:(resolve_path prog_name) ...
```

Contributor guide

Open the contributing guide

Research direction

The request points to spawn.mli; start by reading the existing [prog] documentation and the surrounding spawn API. Done means documenting the intended PATH-resolution method, or clarifying whether a helper is in scope; no test file is named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.