10000 Link to the classes and methods documentation by eregon · Pull Request #1142 · ffi/ffi · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000

Link to the classes and methods documentation #1142

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 19, 2025
Merged

Link to the classes and methods documentation #1142

merged 1 commit into from
May 19, 2025

Conversation

eregon
Copy link
Collaborator
@eregon eregon commented Feb 17, 2025

No description provided.

@eregon
8000 Copy link
Collaborator Author
eregon commented Feb 17, 2025

Mmh for some reason https://www.rubydoc.info/gems/ffi/FFI/Pointer is way worse than in an older version https://www.rubydoc.info/gems/ffi/1.16.3/FFI/Pointer : less methods, doesn't know it inherits from AbstractMemory.
In fact AbstractMemory is almost empty on https://www.rubydoc.info/gems/ffi/FFI/AbstractMemory but is better on https://www.rubydoc.info/gems/ffi/1.16.3/FFI/AbstractMemory

@eregon
Copy link
Collaborator Author
eregon commented Feb 17, 2025

1.71.0 seems also fine https://www.rubydoc.info/gems/ffi/1.17.0/FFI/Pointer so it seems only 1.17.1 is very incomplete.
Maybe some issue during docs generation or maybe due to actual changes in this repo?

@larskanis
Copy link
Member

Local generated yard documentation looks good, but https://www.rubydoc.info/gems/ffi/1.17.1/FFI/Pointer misses all C files. No idea why this happens. Even the gem diff doesn't show me a good reason.

@eregon
Copy link
Collaborator Author
eregon commented Feb 17, 2025

Local generated yard documentation looks good

Then maybe we should do something like https://github.com/ruby-concurrency/concurrent-ruby/blob/master/.github/workflows/docs.yml which automatically publishes the docs to GitHub pages.

@eregon
Copy link
Collaborator Author
eregon commented May 19, 2025

https://bugs.ruby-lang.org/issues/21350#note-1 has a simple workflow for hosting RDoc docs as GitHub Pages.
That seems a good solution.

@eregon eregon mentioned this pull request May 19, 2025
Open
@eregon
Copy link
Collaborator Author
eregon commented May 19, 2025

The problem seems to have resolved itself somehow, at least
https://www.rubydoc.info/gems/ffi/FFI/Pointer
and
https://www.rubydoc.info/gems/ffi/1.17.1/FFI/Pointer
looks as good as
https://www.rubydoc.info/gems/ffi/1.17.0/FFI/Pointer

So let's merge this.

@eregon eregon merged commit 29ad900 into master May 19, 2025
34 of 63 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfu 393E lly merging this pull request may close these issues.
2 participants
@eregon @larskanis
0