Remove feature descriptions in FEATURES.md
#3479
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
madsmtm
added
S - docs
madsmtm
force-pushed
the
a-bit-of-documentation-on-docsrs
branch
from
88ed94e to
75854b5
Compare
madsmtm
force-pushed
the
remove-features-descriptions
branch
from
b7e9f7a to
9a5b5c6
Compare
daxpedda
reviewed
Feb 28, 2024
|
bump |
daxpedda
approved these changes
Mar 16, 2024
There was a problem hiding this comment.
I feel like this file is now quite small and its contents should either live in README.md, CONTRIBUTING.md or be removed entirely.
There was a problem hiding this comment.
I'll do that in a follow-up
|
@madsmtm do you still want to move on with this? |
notgull
approved these changes
Aug 23, 2024
madsmtm
force-pushed
the
remove-features-descriptions
branch
from
9a5b5c6 to
b62d6e8
Compare
madsmtm
force-pushed
the
remove-features-descriptions
branch
from
b62d6e8 to
cb01cdd
Compare
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.
Builds upon #3478. Related to #3431.
I went through all of the text in
FEATURES.md, and cross-referenced it with our code, and as I suspected, the information in the code is much more detailed and up to date. So I propose we remove most of the contents inFEATURES.md, as it is difficult to keep up to date, and I don't really see the value provided.Only thing I'm unsure about is the following three points that are yet unimplemented, and as such doesn't have a clear reference in our code: