From: merch-redmine@jeremyevans.net
To: ruby-core@ruby-lang.org
Subject: [ruby-core:96985] [Ruby master Bug#16506] Documentation for `Module#const_souce_location` is wrong
Date: Thu, 23 Jan 2020 17:26:22 +0000 (UTC) [thread overview]
Message-ID: <redmine.journal-84042.20200123172621.6e0e5c7212579482@ruby-lang.org> (raw)
In-Reply-To: redmine.issue-16506.20200112181728@ruby-lang.org
Issue #16506 has been updated by jeremyevans0 (Jeremy Evans).
Status changed from Open to Closed
Fixed by commit:2bde7919a0a8302c344e9bb9ddc217958fcbd3c7
----------------------------------------
Bug #16506: Documentation for `Module#const_souce_location` is wrong
https://bugs.ruby-lang.org/issues/16506#change-84042
* Author: sawa (Tsuyoshi Sawada)
* Status: Closed
* Priority: Normal
* Assignee:
* Target version:
* ruby -v: 2.7
* Backport: 2.5: UNKNOWN, 2.6: UNKNOWN, 2.7: UNKNOWN
----------------------------------------
https://ruby-doc.org/core-2.7.0/Module.html#method-i-const_source_location says:
> Returns the Ruby source filename and line number containing **first** definition of constant specified.
It should be:
> Returns the Ruby source filename and line number containing the **last** definition (the effective definition) of the constant specified.
It also has an example line:
```ruby
p Object.const_source_location('A') # => ["test.rb", 1] -- note it is first entry, not "continuation"
```
but that may give the impression that the first-ness is due to the nature of this method. The reason `["test.rb", 1]` is returned instead of `["test.rb", 14]` is because the constant is created at line 1, and is only reopened/modified in line 14. Perhaps, this line can be changed to:
```ruby
p Object.const_source_location('A') # => ["test.rb", 1] -- note 'A' is created in line 1, and is only reopened/modified in "continuation"
```
Adding something like this may make it clear that it is the last definition that is returned:
```ruby
D = 'D1'
D = 'D2'
D = 'D3'
...
Object.const_source_location('D') # => returns the location that corresponds to 'D3'
--
https://bugs.ruby-lang.org/
prev parent reply other threads:[~2020-01-23 17:26 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <redmine.issue-16506.20200112181728@ruby-lang.org>
2020-01-12 18:17 ` [ruby-core:96809] [Ruby master Bug#16506] Documentation for `Module#const_souce_location` is wrong sawadatsuyoshi
2020-01-12 18:40 ` [ruby-core:96812] " zverok.offline
2020-01-12 18:41 ` [ruby-core:96814] " zverok.offline
2020-01-19 11:51 ` [ruby-core:96943] " zverok.offline
2020-01-23 17:26 ` merch-redmine [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.ruby-lang.org/en/community/mailing-lists/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=redmine.journal-84042.20200123172621.6e0e5c7212579482@ruby-lang.org \
--to=ruby-core@ruby-lang.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).