-
-
Notifications
You must be signed in to change notification settings - Fork 411
Add documentation for array runtime lowerings for the internal API docs #2653
Conversation
|
Thanks for your pull request and interest in making D better, @JinShil! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.
Please see CONTRIBUTING.md for more information. If you have addressed all reviews or aren't sure how to proceed, don't hesitate to ping us with a simple comment. Bugzilla referencesYour PR doesn't reference any Bugzilla issue. If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog. Testing this PR locallyIf you don't have a local development environment setup, you can use Digger to test this PR: dub fetch digger
dub run digger -- build "master + druntime#2653" |
|
I'm not sure what the problem here is? It's clearly marked as internal API, no? Edit: I see you want to document them. Nevermind. Sorry. |
Yes, but it is publicly available at https://dlang.org/phobos/index.html Currently it looks like this: After this PR it will look like this: So, this PR adds the new |
|
Nothing in |
Yeah, it was an effort I made once to improve the documentation for developers. |
We need to know which way to go though. If you'd like to maintain the status quo, please approve this PR. Otherwise, let me know what you'd like to do; should I submit an alternate PR to remove the |
wilzbach
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I expect nothing. Just wanted to point that out.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Of course it's not a big deal if we don't have documentation for all internal APIs, but we should strive have it regardless, as this helps the work of most contributors.


In my prior PRs (#2647, #2644, #2643, #2634), I did not realize we actually publish documentation on the internal API. This PR repairs that:
cc @Vild. I'm sorry, but I was wrong about not needing to document these; they need to be documented in the "Internal API" docs. You'll just need to add an entry to the
mak/DOCSfile for any new files.I'd like to remove the runtime lowerings from the object.d documentation, but I haven't yet found a solution to that. I thought versioning it out with
version(CoreDoc)would work, but it didn't because these templates are necessary for correct language behavior. I'm investigating other methods.