[docs] Remove course-level linear navigation setting (MDL-89406) - #1679
Open
kieranpgray wants to merge 1 commit into
Open
[docs] Remove course-level linear navigation setting (MDL-89406)#1679kieranpgray wants to merge 1 commit into
kieranpgray wants to merge 1 commit into
Conversation
MDL-89406 removes the enablelinearnav course format option and its course settings field, leaving linear navigation controlled solely by the per-format site setting. The option never shipped in a stable release, so it is removed outright rather than deprecated. Update the linear navigation guide to drop the course_format_options() sample built on linearnavigationsettings::get_course_format_options_default() and ::get_course_format_options_edit_form(), both of which no longer exist, and document the settings.php entry that now controls the feature. Correct the description of what is_linear_navigation_enabled() reads. Drop the matching reference to get_course_format_options_default() from the course format API index. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Tracker: MDL-89406 — Enable linear navigation for all courses and control it through a site-level setting
MDL-89406 removes the
enablelinearnavcourse format option and its course settings field, leaving linear navigation controlled solely by the per-format site setting. The option is absent from v5.2.0 and all earlier tags, so it never shipped in a stable release and is removed outright rather than deprecated.This updates the developer documentation to match.
Changes
docs/apis/plugintypes/format/linear_navigation.mdcourse_format_options()sample calledlinearnavigationsettings::get_course_format_options_default()and::get_course_format_options_edit_form(), both removed by the patch. Thesettings.phpexample previously nested inside it is still current and is promoted to be the section, since it is now the only way a format configures the feature.get_default_linear_navigation_value().is_linear_navigation_enabled(), which read "the linear navigation format option" and now reads the site-level setting for the format.docs/apis/plugintypes/format/index.mdget_course_format_options_default()from thecourse_format_options()row, restoring the wording that preceded 0ca97eb.Notes
The page carries
<Since version="5.3" issueNumber="MDL-84921" />and no newSincemarker is added: as the course-level option never reached a stable release, there is nothing for a 5.3 reader to have known differently. For the same reason the text does not describe the removed course setting — it documents only current behaviour.docs/devupdate.mdwas reviewed and left unchanged; its description of theuses_linear_navigation()opt-in remains accurate.Testing
yarn mdlint— 0 errorscspell— 0 issuesyarn build— succeeds (onBrokenLinks: 'throw'), no anchor warnings🤖 Generated with Claude Code