Skip to content
This repository was archived by the owner on Oct 12, 2022. It is now read-only.

Add documentation for array runtime lowerings for the internal API docs - #2653

Merged
dlang-bot merged 1 commit into
dlang:masterfrom
JinShil:internal_array_docs
Jun 25, 2019
Merged

dlang-bot merged 1 commit into
dlang:masterfrom
JinShil:internal_array_docs

Conversation

@JinShil

@JinShil JinShil commented Jun 25, 2019 •

Copy link
Copy Markdown
Contributor

In my prior PRs (#2647, #2644, #2643, #2634), I did not realize we actually publish documentation on the internal API. This PR repairs that:

image

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/DOCS file 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.

@dlang-bot

Copy link
Copy Markdown

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 verify that your PR follows this checklist:

  • My PR is fully covered with tests (you can see the annotated coverage diff directly on GitHub with CodeCov's browser extension
  • My PR is as minimal as possible (smaller, focused PRs are easier to review than big ones)
  • I have provided a detailed rationale explaining my changes
  • New or modified functions have Ddoc comments (with Params: and Returns:)

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 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.

Testing this PR locally

If 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"

@wilzbach

wilzbach commented Jun 25, 2019 •

Copy link
Copy Markdown
Contributor

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.

@JinShil

JinShil commented Jun 25, 2019 •

Copy link
Copy Markdown
Contributor Author

I'm not sure what the problem here is? It's clearly marked as internal API, no?

Yes, but it is publicly available at https://dlang.org/phobos/index.html

Currently it looks like this:

image

After this PR it will look like this:

image

So, this PR adds the new rt/array files, to maintain the status quo.

@JinShil

JinShil commented Jun 25, 2019

Copy link
Copy Markdown
Contributor Author

Nothing in rt should be called directly by the user, but it is, nevertheless, currently documented and published at https://dlang.org/phobos/index.html

@wilzbach

Copy link
Copy Markdown
Contributor

currently documented and published at

Yeah, it was an effort I made once to improve the documentation for developers.
Though most symbols don't have Ddoc comments, so while it's always welcome to improve the status quo / keep it, for now it's a failed effort.

@JinShil

JinShil commented Jun 25, 2019

Copy link
Copy Markdown
Contributor Author

so while it's always welcome to improve the status quo / keep it, for now it's a failed effort.

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 rt folder from the docs?

@wilzbach wilzbach left a comment

Copy link
Copy Markdown
Contributor

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.

@PetarKirov PetarKirov left a comment •

Copy link
Copy Markdown
Member

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants