Skip to content

Add context to dated information #1013

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged

Conversation

igaray
Copy link
Member

@igaray igaray commented Jan 9, 2021

Searching for references to "future" and "currently", these non-contextualized (context-free? isolated?) sections have been identified and modified.

In addition, the About This Guide and Contributing sections have been updated to reflect our policy of trying to contextualize future additions to the guide.

@igaray igaray force-pushed the 924.add_context_to_may_be_out_of_date_sections branch from f8c1fe6 to 27e59b9 Compare January 9, 2021 13:53
@igaray igaray force-pushed the 924.add_context_to_may_be_out_of_date_sections branch from 27e59b9 to 213db93 Compare January 9, 2021 15:25
@rylev
Copy link
Member

rylev commented Jan 9, 2021

Is there someway to make the data references machine parseable? We could then write a simple tool to remind us when references are ~6 months old, and we should check it they’re still true.

@igaray
Copy link
Member Author

igaray commented Jan 9, 2021

Is there someway to make the data references machine parseable? We could then write a simple tool to remind us when references are ~6 months old, and we should check it they’re still true.

I think this would fall under the general problem of automating keeping documentation and code in sync, and I would love to have a conversation about that.

@camelid
Copy link
Member

camelid commented Jan 10, 2021

Is there someway to make the data references machine parseable? We could then write a simple tool to remind us when references are ~6 months old, and we should check it they’re still true.

If we make sure that they are always of the form "as of {month} {year}" then we could use a simple regex to extract them.

@igaray igaray requested a review from jyn514 January 10, 2021 22:03
@igaray igaray marked this pull request as ready for review January 10, 2021 22:04
@igaray
Copy link
Member Author

igaray commented Jan 10, 2021

Is there someway to make the data references machine parseable? We could then write a simple tool to remind us when references are ~6 months old, and we should check it they’re still true.

If we make sure that they are always of the form "as of {month} {year}" then we could use a simple regex to extract them.

Added this bit

igaray and others added 3 commits January 10, 2021 19:13
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
@igaray igaray changed the title Fixes #924 Add context to dated information Add context to dated information Jan 10, 2021
@igaray igaray merged commit 0a5bb7f into rust-lang:master Jan 10, 2021
@igaray igaray deleted the 924.add_context_to_may_be_out_of_date_sections branch January 10, 2021 22:23
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants