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

Be sure to define 'description' #35804

Merged
merged 3 commits into from
Jan 6, 2025
Merged

Conversation

MichaelChirico
Copy link
Contributor

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:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing.

Copy link

welcome bot commented Jan 1, 2025

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 1, 2025
Copy link
Contributor

github-actions bot commented Jan 1, 2025

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 that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

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

Source Preview Production What Changed
issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review issues Content related to issues and removed triage Do not begin working on this issue until triaged by the team labels Jan 1, 2025
@nguyenalex836
Copy link
Contributor

@MichaelChirico Thanks so much for opening a PR! I'll get this triaged for review ✨

@felicitymay felicitymay added the ready to merge This pull request is ready to merge label Jan 2, 2025
@MichaelChirico
Copy link
Contributor Author

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.

@felicitymay
Copy link
Contributor

Many thanks for your help improving this article ✨

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.

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.

@MichaelChirico
Copy link
Contributor Author

MichaelChirico commented Jan 2, 2025

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 :)

@nguyenalex836 nguyenalex836 removed the waiting for review Issue/PR is waiting for a writer's review label Jan 6, 2025
@nguyenalex836 nguyenalex836 added this pull request to the merge queue Jan 6, 2025
Merged via the queue into github:main with commit 4e8773c Jan 6, 2025
45 checks passed
Copy link
Contributor

github-actions bot commented Jan 6, 2025

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team issues Content related to issues ready to merge This pull request is ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants