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

Rename "latest" to "development" #337

Closed
nalimilan opened this issue Nov 1, 2016 · 5 comments
Closed

Rename "latest" to "development" #337

nalimilan opened this issue Nov 1, 2016 · 5 comments

Comments

@nalimilan
Copy link
Contributor

Wouldn't it be better to refer to docs from git master as "development" rather than "latest"? In Julia Base, users frequently get confused when reading the manual for the development version and expecting them to work on the latest release. I'm afraid the same could happen with packages documentation. It's always better to be explicit, as "latest" may convey the idea of "most up-to-date".

@MichaelHatherly
Copy link
Member

It's probably possible to change the naming scheme now, but given the number of packages already using latest and stable it's going cause some grief with link changes.

I think the simplest approach is for package authors to label each link to the docs in their readme in a clear way. The wording in Documenter's readme seems to have been doing alright as far as I can tell.

@ChrisRackauckas
Copy link
Contributor

"Master"? A lot of people have a "dev" branch which is not "a stable dev branch" like "master".

@nalimilan
Copy link
Contributor Author

Yeah, the description of the links is explicit in the README, but the bold LATEST still isn't ideal, and not all packages will necessarily keep the full description. Of course I know changing links will be disruptive; I'm not sure what's the best way to handle that, but there must be ways to ease the transition.

@tpoisot
Copy link

tpoisot commented Nov 24, 2016

I agree with @ChrisRackauckas -- having a dev branch is common, and it would be good to have a documentation for it -- I would favor "development" for a dev branch.

@mortenpi
Copy link
Member

This was changed in #802.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants