') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); Add documentation for ConsoleKey.None and ConsoleModifiers.None by terrajobst · Pull Request #8893 · dotnet/dotnet-api-docs · GitHub
Skip to content

Add documentation for ConsoleKey.None and ConsoleModifiers.None - #8893

Closed
terrajobst wants to merge 1 commit into
dotnet:mainfrom
terrajobst:console-modifiers
Closed

Add documentation for ConsoleKey.None and ConsoleModifiers.None#8893
terrajobst wants to merge 1 commit into
dotnet:mainfrom
terrajobst:console-modifiers

Conversation

@terrajobst

Copy link
Copy Markdown
Contributor

Summary

This adds reference documentation for dotnet/runtime#83114.

/cc @stephentoub@carlossanlop

@gewarren

Copy link
Copy Markdown
Collaborator

I think there was a misunderstanding - Stephen was referring to XML comments in the ///, not here. I think we should close this PR since we don't want to publish it before Preview 3.

@terrajobst

Copy link
Copy Markdown
ContributorAuthor

@gewarren

I think there was a misunderstanding - Stephen was referring to XML comments in the ///, not here. I think we should close this PR since we don't want to publish it before Preview 3.

For some assemblies we currently don't do ///, which includes these two types. How are those being documented then? Or is this just a function of waiting until automation populates the API entry in this repo?

@gewarren

Copy link
Copy Markdown
Collaborator

Yes, wait until automation populates the XML files in this docs repo. Even if you're not building documentation files when you compile, Carlos can use his tool to port the comments over from ///. However, he said that he's not going to do that until RC, so if you wanted to add descriptions before RC, you can come back here when Preview 3 ships and update the <summary> manually.

@learn-build-service-prod

Copy link
Copy Markdown

Learn Build status updates of commit 5c8e1fb:

✅ Validation status: passed

FileStatusPreview URLDetails
xml/System/ConsoleKey.xml✅SucceededView
xml/System/ConsoleModifiers.xml✅SucceededView

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@terrajobst

Copy link
Copy Markdown
ContributorAuthor

Sounds good, will do. Thanks!

@terrajobst
terrajobst deleted the console-modifiers branch April 7, 2023 01:02
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@terrajobst@gewarren