Avoid accessing RDoc objects through Store
#1308
Merged
+19
−28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying rdoc with
|
| Latest commit: |
0be6655
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9bdab36e.rdoc-6cd.pages.dev |
| Branch Preview URL: | https://reduce-store-and-rdoc-coupli.rdoc-6cd.pages.dev |
tompng
reviewed
Mar 9, 2025
| # the documentation tree to access user-set options, for example. | ||
|
|
||
| attr_accessor :rdoc | ||
| attr_writer :rdoc |
There was a problem hiding this comment.
I think RDoc::Store only needs attr_accessor :options, but we need to consider the initialization order of rdoc.options and store.rdoc. Maybe we can do it in another followup pull request later.
There was a problem hiding this comment.
I have a WIP PR for that (which was meant to be part of this PR). I still have a few tests to fix but can open a draft for it after this is merged.
tompng
approved these changes
Mar 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There's an unhealthy coupling between
RDocandStore, where they hold reference of each other and access things both ways.IMO,
RDocinstances holdingStoreobjects makes sense asStoreis a component of it. ButStoreshouldn't need to reference back to itsRDocinstance.This PR is the first step of removing this coupling by dropping
Store#rdocusages.