[#106355] [Ruby master Bug#18373] RBS build failure: '/include/x86_64-linux/ruby/config.h', needed by 'constants.o'. — "vo.x (Vit Ondruch)" <noreply@...>
Issue #18373 has been reported by vo.x (Vit Ondruch).
28 messages
2021/12/01
[ruby-core:106661] [Ruby master Misc#18404] 3.1 documentation problems tracking ticket
From:
"zverok (Victor Shepelev)" <noreply@...>
Date:
2021-12-14 16:08:11 UTC
List:
ruby-core #106661
Issue #18404 has been updated by zverok (Victor Shepelev). @matheusrich if you are willing to participate, let's coordinate efforts here for better visibility :) Are you willing to write some docs yourself? You'll need to fork [ruby repo](https://github.com/ruby/ruby), make a local branch, fix docs, check them locally (you can run `rdoc -o _rdoc_test` to render them into a separate folder; you also can run `rdoc some_file.c -o rdoc_test` to render them quicker from only one file), and then make a PR to the original repo. Which part you'd like to handle? ---------------------------------------- Misc #18404: 3.1 documentation problems tracking ticket https://bugs.ruby-lang.org/issues/18404#change-95333 * Author: zverok (Victor Shepelev) * Status: Open * Priority: Normal ---------------------------------------- So far, comparing the NEWS.md to actual documentation at https://docs.ruby-lang.org/en/master/, I identified the following problems: * Hash/keyword argument value omission—completely undocumented. PR: https://github.com/ruby/ruby/pull/5244 * New [Refinement](https://docs.ruby-lang.org/en/master/Refinement.html) class has no docs whatsoever. (NB: docs for `#import_methods` are [written](https://github.com/ruby/ruby/blob/v3_1_0_preview1/eval.c#L1537), but I can't make them render anywhere yet * [Queue::new](https://docs.ruby-lang.org/en/master/Thread/Queue.html#method-c-new) should be rewritten (bad rendering for example, non-informative parameter name * [Struct](https://docs.ruby-lang.org/en/master/Struct.html): `#keyword_init?` isn't mentioned anywhere * `Thread::Backtrace.limit` isn't mentioned anywhere (`Thread::Backtrace` doesn't even have its own page, only [Thread::Backtrace::Location](https://docs.ruby-lang.org/en/master/Thread/Backtrace/Location.html) has) * [GC](https://docs.ruby-lang.org/en/master/GC.html): `::measure_total_time`, `::measure_total_time=`, `::total_time` isn't mentioned anywhere: * [Fiber::SchedulerInterface ](https://docs.ruby-lang.org/en/master/Fiber/SchedulerInterface.html) — no docs for new methods supported: `address_resolve`, `timeout_after`, `io_read`, `io_write` * [IO::Buffer](https://docs.ruby-lang.org/en/master/IO/Buffer.html) no docs Small glitches in new docs: * [Process._fork](https://docs.ruby-lang.org/en/master/Process.html#method-c-_fork) formatting of `tt` * [Integer#try_convert](https://docs.ruby-lang.org/en/master/Integer.html#method-c-try_convert): small typo: "Returns nil if object does not respond to **:to_ary**" (should be `:to_int`) I'll try to address as much as I'll be able myself, but if some of the feature authors/other volunteers are willing to participate, I'll be glad :) The ticket might be expanded if I'll notice something else. -- https://bugs.ruby-lang.org/ Unsubscribe: <mailto:[email protected]?subject=unsubscribe> <http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>