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

Split out the file and fqn selection methods into their own sections #4083

Merged
merged 3 commits into from
Sep 18, 2023

Conversation

dbeatty10
Copy link
Contributor

@dbeatty10 dbeatty10 commented Sep 16, 2023

🎩 Previews

What are you changing in this pull request and why?

The file and fqn selections methods are distinct from each other, but they've been documented within the same section. They deserve their own sections, just like the rest of the methods.

History

The fqn method was undocumented for some amount of time, and #1851 added the initial documentation.

On con

  • If anyone has a hyperlink that is using the previous anchor, it will no longer go to that same section.

i.e., this will no longer exist:

Instead, it will be split into these two:

But #1851 would have had the same issue (but in reverse), so in a sense, we'd be just returning to the anchor that was in use previously.

Side note: there might be some way to override the value of the anchor if we wanted it to be different than the default.

My recommendation is to just leave this PR as-is (without messing with the auto-generated anchors).

Checklist

@vercel
Copy link

vercel bot commented Sep 16, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 18, 2023 8:32am

@github-actions github-actions bot added content Improvements or additions to content size: small This change will take 1 to 2 days to address labels Sep 16, 2023
@dbeatty10 dbeatty10 marked this pull request as ready for review September 16, 2023 01:10
@dbeatty10 dbeatty10 requested a review from a team as a code owner September 16, 2023 01:10
Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

thanks @dbeatty10 and def agree that both fqn and file should have their own sections so it's more explicit for users.

in terms of redirects, unfortunately, we can't redirect from links that contain anchor/hash links.

@mirnawong1 mirnawong1 merged commit 1e26869 into current Sep 18, 2023
7 checks passed
@mirnawong1 mirnawong1 deleted the dbeatty/split-file-fqn branch September 18, 2023 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants