Fix choice of main page #284
Merged
Conversation
This file contains hidden or 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
Prior to this commit, `RDoc::Generator::SDoc#index` exhibited the following incorrect behaviors: 1. When `--main` was not specified, `index` would choose the alphabetically-first file as the main page, instead of the first file in the list of files. 2. When `--main` was specified but was prefixed with `--root`, and `--root` did not start with "rails/", `index` would choose the alphabetically-first file. (Such as when `--root` was an absolute path, or a deeply nested relative path, or simply a path for a non-Rails project.) 3. When `--main` was specified but was not in the list of files, `index` would choose the alphabetically-first file. This commit fixes `RDoc::Generator::SDoc#index` such that it: 1. Chooses the first file in the list of files as the default main page. 2. Handles any kind of `--main` path. 3. Raises an error when `--main` isn't among the rendered files.
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.
Prior to this commit,
RDoc::Generator::SDoc#indexexhibited the following incorrect behaviors:When
--mainwas not specified,indexwould choose the alphabetically-first file as the main page, instead of the first file in the list of files.When
--mainwas specified but was prefixed with--root, and--rootdid not start with "rails/",indexwould choose the alphabetically-first file. (Such as when--rootwas an absolute path, or a deeply nested relative path, or simply a path for a non-Rails project.)When
--mainwas specified but was not in the list of files,indexwould choose the alphabetically-first file.This commit fixes
RDoc::Generator::SDoc#indexsuch that it:Chooses the first file in the list of files as the default main page.
Handles any kind of
--mainpath.Raises an error when
--mainisn't among the rendered files.