Skip to content

Comments

Fix REF links in std.file.slurp#5509

Merged
dlang-bot merged 1 commit intodlang:stablefrom
wilzbach:fix-ddoc-std-file
Jun 24, 2017
Merged

Fix REF links in std.file.slurp#5509
dlang-bot merged 1 commit intodlang:stablefrom
wilzbach:fix-ddoc-std-file

Conversation

@wilzbach
Copy link
Contributor

We really should get rid off this anti-feature in Ddoc to auto-magically highlight all words in the doc that match the parameter or name of the symbol ... it's highly error-prone!

https://dlang.org/phobos/std_file.html#.slurp

image

@wilzbach wilzbach added the Review:Trivial typos, formatting, comments label Jun 23, 2017
@dlang-bot
Copy link
Contributor

dlang-bot commented Jun 23, 2017

Thanks for your pull request, @wilzbach! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.

Some things that can help to speed things up:

  • smaller, focused PRs are easier to review than big ones

  • try not to mix up refactoring or style changes with bug fixes or feature enhancements

  • provide helpful commit messages explaining the rationale behind each change

Bear in mind that large or tricky changes may require multiple rounds of review and revision.

Please see CONTRIBUTING.md for more information.

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

@wilzbach wilzbach force-pushed the fix-ddoc-std-file branch from 688d5c4 to fe390f1 Compare June 23, 2017 13:31
std/file.d Outdated
* passed to $(REF formattedRead, std,format), and therefore must conform to the
* format string specification outlined in $(MREF format).
* passed to $(REF formattedRead, std,_format), and therefore must conform to the
* format string specification outlined in $(MREF _format).
Copy link
Member

@PetarKirov PetarKirov Jun 23, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something is not right because now $(MREF _format) points to _format.html. See: http://dtest.dlang.io/artifact/website-6d28a546dff7ca825b137033aeb6aae40b31bfd1-b44f14d07a242b08d63ddb77aae7a686/web/phobos-prerelease/std_file.html#slurp

Also I think it would read better if it rendered as std.format. format. (with a dot part of the link) just looks weird, though I'm not sure why the dot gets sucked in the macro.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It points to format_.html (underscore is on the other side). Should be: $(MREF std,_format).

@wilzbach wilzbach force-pushed the fix-ddoc-std-file branch from fe390f1 to d2c5c53 Compare June 24, 2017 02:49
@wilzbach
Copy link
Contributor Author

Btw I just found this by accident, but really should fix the root of the problem ...

It points to format_.html (underscore is on the other side). Should be: $(MREF std,_format).

Excellent catch, @aG0aep6G!

@dlang-bot dlang-bot merged commit b147807 into dlang:stable Jun 24, 2017
@wilzbach wilzbach deleted the fix-ddoc-std-file branch December 11, 2017 02:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants