Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that CStr::as_ptr returns a type alias #108124

Merged
merged 1 commit into from
Feb 20, 2023

Conversation

kornelski
Copy link
Contributor

Rustdoc resolves type aliases too eagerly #15823 which makes the std re-export of CStr::as_ptr show i8 instead of c_char. To work around this I've added info about c_char in the method's description.

BTW, I've also added a comment to what-not-to-do example in case someone copypasted it without reading the surrounding text.

@rustbot
Copy link
Collaborator

rustbot commented Feb 16, 2023

r? @thomcc

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Feb 16, 2023
@rustbot
Copy link
Collaborator

rustbot commented Feb 16, 2023

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@thomcc
Copy link
Member

thomcc commented Feb 20, 2023

Looks fine, even if that bug is fixed this isn't a problem.

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Feb 20, 2023

📌 Commit fd89470 has been approved by thomcc

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 20, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Feb 20, 2023
Document that CStr::as_ptr returns a type alias

Rustdoc resolves type aliases too eagerly rust-lang#15823 which makes the [std re-export](https://doc.rust-lang.org/stable/std/ffi/struct.CStr.html#method.as_ptr) of `CStr::as_ptr` show `i8` instead of `c_char`. To work around this I've added info about `c_char` in the method's description.

BTW, I've also added a comment to what-not-to-do example in case someone copypasted it without reading the surrounding text.
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 20, 2023
…iaskrgr

Rollup of 5 pull requests

Successful merges:

 - rust-lang#108124 (Document that CStr::as_ptr returns a type alias)
 - rust-lang#108171 (Improve building compiler artifacts output)
 - rust-lang#108200 (Use restricted Damerau-Levenshtein distance for diagnostics)
 - rust-lang#108259 (remove FIXME that doesn't require fixing)
 - rust-lang#108265 ("`const` generic" -> "const parameter")

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit fde38f1 into rust-lang:master Feb 20, 2023
@rustbot rustbot added this to the 1.69.0 milestone Feb 20, 2023
@kornelski kornelski deleted the cstr_c_char branch November 6, 2023 00:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants