-
-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create new array-based RSS feed config structure #1258
Merged
Merged
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
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:17 — with
GitHub Actions
Inactive
Codecov Report
@@ Coverage Diff @@
## master #1258 +/- ##
==========================================
Coverage ? 100.00%
Complexity ? 2632
==========================================
Files ? 304
Lines ? 6908
Branches ? 0
==========================================
Hits ? 6908
Misses ? 0
Partials ? 0
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:20 — with
GitHub Actions
Inactive
caendesilva
force-pushed
the
finalize-rss-configuration
branch
from
March 12, 2023 20:22
0674d68
to
e85dac0
Compare
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:22 — with
GitHub Actions
Inactive
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:25 — with
GitHub Actions
Inactive
caendesilva
force-pushed
the
finalize-rss-configuration
branch
from
March 12, 2023 20:27
7d0c7ce
to
93fd546
Compare
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:27 — with
GitHub Actions
Inactive
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:28 — with
GitHub Actions
Inactive
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:28 — with
GitHub Actions
Inactive
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:30 — with
GitHub Actions
Inactive
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:31 — with
GitHub Actions
Inactive
caendesilva
temporarily deployed
to
pr-documentation-1258
March 12, 2023 20:32 — with
GitHub Actions
Inactive
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.
Updates the RSS configuration array settings
Development
I believe this to be the (or one of the) last breaking change as HydePHP enters GA in two days.
While this is a breaking change, the impact is very low. It's a really easy change, and I don't think that many people have changed this setting, and the BC has not fully kicked in yet, so I think the risk is acceptable.
Changes the following in
config/hyde.php
:To instead be like this:
Benefits & Drawbacks
The benefits of changing the config file structure to use nested arrays as shown in the second code block are:
Clarity and organization: Using nested arrays to group related configuration options makes it easier to understand the purpose and organization of the options, which can improve the overall clarity of the codebase.
Flexibility: By grouping related options into a nested array, it can make it easier to add additional related options in the future.
Reduced potential for naming conflicts: Grouping related options into a nested array can help prevent naming conflicts between options that may have similar or identical names.
The drawbacks of changing the config file structure to use nested arrays are:
Increased complexity: The use of nested arrays can add complexity to the codebase, as developers may need to navigate multiple levels of arrays to access the desired configuration option.
Backwards compatibility issues: If this is a widely used configuration file, changing its structure can create compatibility issues with existing code that expects the original structure.
Increased verbosity: The use of nested arrays can make the code more verbose, especially when accessing the configuration values. In effect, however, this is not a concern as
rss_description
is not much different thanrss.description
.Visual discrepancy with the
generate_sitemap
optionThis section was written by ChatGPT (excluding point 4)