premake / premake/premake-core

Deprecation language in docs is not clear.

Open
#2,222 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

support-request
Dominant language
C
Stars
3.6k
Forks
654
Avg merge
1d 1h
Merged PRs (30d)
13

Description

What are you trying to do?
Documentation description of intent to later deprecate is ambiguous.

Docs read: x64: Alias for x86_64; There is intent to deprecate this

Which one? x64 alias will be deprecated or the x86_64 specifier will be deprecated and x64 will take its' place?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the documentation for the exact sentence “x64: Alias for x86_64; There is intent to deprecate this.” Read the surrounding descriptions to determine which identifier is intended for deprecation, then revise the wording so the intended future change is unambiguous and verify the rendered documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.