-
Notifications
You must be signed in to change notification settings - Fork 60.5k
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
Be sure to define 'description' #35804
base: main
Are you sure you want to change the base?
Conversation
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
@MichaelChirico Thanks so much for opening a PR! I'll get this triaged for review ✨ |
...ent/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md
Outdated
Show resolved
Hide resolved
...ent/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md
Show resolved
Hide resolved
I have no context to offer improvements for the CI errors -- I leave it to the reviewer's judgment whether those should be addressed here or in a separate PR. |
Many thanks for your help improving this article ✨
It looks as if the CI error is a problem with one of our internal workflows that was triggered when I added a label to indicate that this is ready to merge. It's not a required test, but I'll follow up on this internally. You'll need to wait longer than usual for this PR to be merged and in production. We're resuming updates next week. |
Take your time / no rush at all. Please prioritize other work first as appropriate. I will lose no sleep over the status of this PR :) |
Why:
In Rdatatable/data.table#6692, we considered doing this definition ourselves, but decided that it's better for GitHub's own docs to be more explicit about the term.
The point is that 'description' may not be perfectly clear to a new user & is used several times on this page. Better to avoid potential frustration and be overly verbose about what 'description' is.
Check off the following: