Skip to content
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

NEWS.md is getting a bit untidy #26508

Closed
cormullion opened this issue Mar 18, 2018 · 5 comments
Closed

NEWS.md is getting a bit untidy #26508

cormullion opened this issue Mar 18, 2018 · 5 comments
Labels
domain:docs This change adds or pertains to documentation

Comments

@cormullion
Copy link
Contributor

cormullion commented Mar 18, 2018

I think NEWS.md is getting quite large and could do with more structure. I took a section and added a tag to each of the (currently 143) items, then sorted by tag. I think it looks better — but the section names await the enthusiastic "bikeshedding" that we all love so much!

Each item got one of the following tags (sometimes I did struggle to assign just one):

##array
##date
##env (environment)
##io
##lang (language)
##linalg (linear algebra)
##math
##random
##string
##type 

then after sorting (and removing the tags, making titles) we get this:

========================================

Deprecated

Array

Date

Env

Io

Lang

Linalg

Math

Random

String

Type

========================================

I almost think it would be a good idea if each item was tagged permanently, to allow for searching/selection, and so on...

@StefanKarpinski
Copy link
Sponsor Member

Let's do the tidying step first, but I agree that persistent tagging would be good too.

@JeffBezanson
Copy link
Sponsor Member

Agreed, NEWS needs a lot of editing and tidying at this point. We need to merge a few more PRs first though. Unfortunately if we do tagging, there needs to be a "misc" tag. For example, tic/toc, workspace, and EnvHash don't have anything meaningful in common.

@cormullion
Copy link
Contributor Author

The “env” subsection could be renamed “general/misc”; it started out as “general Julia/environment” anyway and #env was quicker to type... 😀 Eventually it should be done properly...

@kshyatt kshyatt added the domain:docs This change adds or pertains to documentation label May 28, 2018
@StefanKarpinski
Copy link
Sponsor Member

Is there anything to be done here?

@cormullion
Copy link
Contributor Author

I think you can close this. Perhaps by the time the next huge release starts to loom we can explore some finer-grained ways of organizing hundreds of items. But that's some way off, I'm guessing... :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

5 participants