Skip to content

std::env::var should mention env! or option_env! #138159

New issue
New issue
Closed
#138189
Closed
std::env::var should mention env! or option_env!#138159
#138189
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsE-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.T-libsRelevant to the library team, which will review and decide on the PR/issue.

Description

@cyrgani
cyrgani
opened on Mar 7, 2025

Location

std::env::var

Summary

std::env::var operates at runtime, env! and option_env! at compile time.
The reverse link from the macro to the function exists already, but env! / option_env! should also be mentioned in std::env::var's docs.

Activity

  1. cyrgani
    added
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    on Mar 7, 2025
  2. rustbot
    added
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Mar 7, 2025

  3. GuillaumeGomez commented on Mar 7, 2025

    @GuillaumeGomez
    GuillaumeGomez
    on Mar 7, 2025
    Member

    Interested into sending a fix?

  4. jieyouxu
    added
    T-libsRelevant to the library team, which will review and decide on the PR/issue.
    E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
    and removed
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Mar 7, 2025

  5. CosminPerRam commented on Mar 7, 2025

    @CosminPerRam
    CosminPerRam
    on Mar 7, 2025

    I'm up for the fix if OP is not.

  6. GuillaumeGomez commented on Mar 7, 2025

    @GuillaumeGomez
    GuillaumeGomez
    on Mar 7, 2025
    Member

    Sorry, only saw your message after opening #138189...

  7. jhpratt
    added a commit that references this issue on Mar 8, 2025

    Rollup merge of rust-lang#138189 - GuillaumeGomez:env-var, r=joshtrip…

    6576d35
  8. bors
    closed this as completedin 6576d35on Mar 8, 2025
  9. rust-timer
    added a commit that references this issue on Mar 8, 2025

    Unrolled build for rust-lang#138189

    d754a6e
  10. github-actions
    added a commit that references this issue on Mar 14, 2025

    Rollup merge of rust-lang#138189 - GuillaumeGomez:env-var, r=joshtrip…

    9769e9f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsE-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.T-libsRelevant to the library team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions