Add notes related to phobos.sys.meta and std.meta. #36
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
It seemed like it would be a good idea to document which symbols in Phobos v2 map to which ones in Phobos v3, as well as to document which symbols are _not_ being ported to Phobos v3 (and why). In addition, it seems sensible to document at least some of the design decisions. And it will also help me keep track of where things stand for myself when figuring out what I still need to do - though who knows whether anyone else will be doing this kind of documentation later for the stuff that they work on. Either way, when Phobos v3 gets released, we _are_ going to need to put together information for users somewhere for what ended up where in Phobos v3 so that they can port their Phobos v2 code to v3 if they so desire (and generally find stuff in v3 that they're familiar with in v2). And documentation like this commit has can at least provide the basis for that even if it's not what we're going to give to users (presumably, that will need to be in ddoc on dlang.org). So, I've started a section of the repo for providing notes for each module as we add them (as well as notes for the old modules so that we can provide links to the new symbols and provide information about symbols that are not getting ported over). So, the intention at least is that each public module in Phobos v2 and each public module in Phobos v3 will eventually end up with a corresponding file under module_notes, but we'll see.
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.
It seemed like it would be a good idea to document which symbols in Phobos v2 map to which ones in Phobos v3, as well as to document which symbols are not being ported to Phobos v3 (and why). In addition, it seems sensible to document at least some of the design decisions. And it will also help me keep track of where things stand for myself when figuring out what I still need to do - though who knows whether anyone else will be doing this kind of documentation later for the stuff that they work on.
Either way, when Phobos v3 gets released, we are going to need to put together information for users somewhere for what ended up where in Phobos v3 so that they can port their Phobos v2 code to v3 if they so desire (and generally find stuff in v3 that they're familiar with in v2). And documentation like this commit has can at least provide the basis for that even if it's not what we're going to give to users (presumably, that will need to be in ddoc on dlang.org).
So, I've started a section of the repo for providing notes for each module as we add them (as well as notes for the old modules so that we can provide links to the new symbols and provide information about symbols that are not getting ported over). So, the intention at least is that each public module in Phobos v2 and each public module in Phobos v3 will eventually end up with a corresponding file under module_notes, but we'll see.