FIX: .inputactions Inspector help button opens a missing documentation page [UUM-149518] - #2471
Conversation
…n page [UUM-149518]
The Inspector help button shown when an .inputactions asset is selected ("Open Reference for Input Action Importer") lands on the documentation site's 404 page.
InputActionImporter, the ScriptedImporter backing .inputactions assets, carried no [HelpURL] attribute, so UnityEditor fell back to the auto-generated documentation URL for the type, which has no published page. The class declaration now carries [HelpURL(InputSystem.kDocUrl + "/manual/action-assets.html")] alongside its existing [ScriptedImporter] attribute, the same pattern already used for the package's other Inspector-visible types, pointing the button at the Action Assets manual page that covers what this importer's inspector exposes.
Jira: https://jira.unity3d.com/browse/UUM-149518
![u-pr[bot]](https://avatars.githubusercontent.com/in/1201017?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Harness Review
The importer now declares a package manual HelpURL, and the accompanying API test verifies that it resolves to the existing action-assets documentation page. I examined the attribute usage, URL construction, documentation mapping, test path conventions, and changelog entry.
Reviewed commit 9fea82f
🤖 Helpful? 👍/👎
Codecov ReportAttention: Patch coverage is
@@ Coverage Diff @@
## develop #2471 +/- ##
===========================================
- Coverage 78.95% 78.95% -0.01%
===========================================
Files 767 767
Lines 140780 140822 +42
===========================================
+ Hits 111153 111180 +27
- Misses 29627 29642 +15 Flags with carried forward coverage won't be shown. Click here to find out more.
|
suearkinunity
left a comment
suearkinunity
left a comment
There was a problem hiding this comment.
I'm not familiar with the mechanism behind the buttons, so I reviewed only the release note.
VeraMommersteeg
left a comment
VeraMommersteeg
left a comment
There was a problem hiding this comment.
lgtm. failing test looks to be due to .net upgade missing. which is unrelated to these changes. the other failing test after rerunning was green. so it seems an instability
3 participants
Description
Note
This pull request was generated automatically. Please review carefully before merging.
Selecting an
.inputactionsasset shows an Inspector help button labelled "Open Reference for Input Action Importer".UnityEngine.InputSystem.Editor.InputActionImporter, theScriptedImporterthat backs those assets, carried no[HelpURL]attribute, soUnityEditorfell back to the auto-generated documentation URL for the type. No page is published at that address, so clicking the button opened the documentation site's "Sorry... that page seems to be missing!" 404 page.The class declaration now carries
[HelpURL(InputSystem.kDocUrl + "/manual/action-assets.html")]next to its existing[ScriptedImporter(kVersion, InputActionAsset.Extension)]attribute, which is the pattern already used across the package for Inspector-visible types such asPlayerInputandInputSystemUIInputModule.Documentation~/action-assets.mdalready exists and covers what this importer's inspector exposes (the.inputactionsasset, project-wide assignment, and "Generate C# API from actions"), so no documentation page had to be added.Testing status & QA
Assets/Tests/InputSystem/APIVerificationTests.cs[Test] API_InputActionImporterHasHelpUrlToExistingManualPage, which also resolves the URL back to itsDocumentation~markdown file so a future rename of the page is caught. The two existing help-URL tests filter to publicMonoBehaviourtypes and therefore do not cover this importer..inputactionsasset and click the Inspector help button; it should open the Action Assets manual page rather than a 404.Overall Product Risks
API_MonoBehaviourHelpUrlsAreValidfilters to public MonoBehaviours so this URL stays unvalidated by CI; the targetaction-assets.mdwas verified present inDocumentation~andTableOfContents.md.Comments to reviewers
If a narrower landing page is preferred,
about-action-assets.htmlandgenerate-cs-api-from-actions.htmlare the alternatives.Checklist
Before review:
Changed,Fixed,Addedsections.Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.