Announcement

Collapse
No announcement yet.

Reporting Issues for Documentation

Collapse
This is a sticky topic.
X
X
  • Filter
  • Time
  • Show
Clear All
new posts

  • started a topic Reporting Issues for Documentation

    Reporting Issues for Documentation

    First off, thank you for taking the time to help us improve UE4 Documentation!

    We request that issues found within documentation please be submitted within this thread (this may change at a later date). If you have multiple issues to report, we ask that you use your best judgment and if need be make a separate reply for each. This will allow us to track each issue more easily.

    HOW TO REPORT ISSUES WITHIN THIS THREAD

    • Please remember to always Search the thread first, to see if your issue has already been reported.
    • If your issue has not been previously reported, then please proceed to reply to this thread specifying what the defect is.
    • Again, please make a new reply for each separate issue, and use the following format whenever you are able:

    Engine version: The version number of the Unreal Engine which you are currently using. For example: 4.7.2. This is mainly for when you are reporting an issue, that a certain portion of documentation is out-of-date, and to show what version of the engine this was checked against.

    Detailed description of the issue: Please remember to include all potentially relevant information (what page you were on, where the issue is located, linking to the page itself).

    Screenshots: We encourage you to include a screenshot(s) whenever they may prove helpful in understanding the issue.

    Additional info that is helpful: Browser used, how you were viewing the documentation (mobile, tablet, second monitor with different resolution). This will be primarily helpful when there appears to be a formatting issue present. Example: I was viewing the documentation on a tablet and the search window is cutoff and unable to use.


    What kind of issues are we asking about?
    • Out-of-date information
    • Spelling or Punctuation errors
    • Out-of-date image(s)
    • Link errors (Wrong page, 404, ex...)
    • Formatting Issues


    Once again, we thank each and every one of you very much for your help!

  • commented on 's reply
    Thanks for reporting this issue. I'll pass this along to the appropriate contact here at Epic.

  • commented on 's reply
    Thanks for your comment! This is something that we've discussed internally, and I'll add your comment to the discussion.

    Note: I happen to be of the 'create a new thread for each unique issue' school of thought :-)

  • replied
    Hi, when you say we should report documentation issues to "this thread", do you mean to this *forum* or literally this specific thread? It seems like a recipe for a mess to keep posting documentation issues to the same 26-page thread, what happens when one issue has a follow-up question or further discussion? Wouldn't it make much more sense to create a new topic for each documentation issue?

    Leave a comment:


  • replied
    Engine Version : 4.22
    Description : Incorrect value for Additional Plist Data
    Link : https://docs.unrealengine.com/en-US/...art/index.html
    Detail :
    Click image for larger version  Name:	plist.jpg Views:	2 Size:	111.8 KB ID:	1647569

    Under iOS in section 2 'Additional Project Configuration', the value for Additional Plist Data should read : <key>NSCameraUsageDescription</key><string>UE4 needs permission to use the camera in order to use ARKit.</string>

    Leave a comment:


  • commented on 's reply
    Confirmed that this content escaped a little early, and should be marked for 4.23 - correction in progress. Great catch!

  • commented on 's reply
    Thanks for reporting this issue. I'll pass this along to the appropriate contact here at Epic.

  • replied
    Engine Version : 4.22
    Description : Incorrect Document for Engine verison 4.22. ( The doc may be for 4.23 )
    Link : https://docs.unrealengine.com/en-US/...nce/index.html
    Detail :
    Click image for larger version

Name:	_15640196678763.png
Views:	1
Size:	105.0 KB
ID:	1646150

    I think this is for engine 4.23 , but the document declare it's for 4.22. You can compare the source code between:
    • /4.23/Engine/Source/Programs/UnrealGameSync/MetadataServer/Global.asax.cs
    • /4.22/Engine/Source/Programs/UnrealGameSync/UnrealGameSyncMetadataServer/Global.asax.cs
    Engine 4.23 changed the database from SQLite to MySql, that's why this config need to be updated for 4.23, but not for 4.22.

    Leave a comment:


  • commented on 's reply
    This has been fixed - thanks for the feedback!

  • replied
    Originally posted by DerHalbDeutscheZ View Post
    I was reading the Introduction to C++ page under the TSet heading (https://docs.unrealengine.com/en-US/...ndex.html#tset) and it states



    However, going through the Action RPG learning resource (https://www.unrealengine.com/marketplace/en-US/slug/action-rpg), I noticed this:



    I'm not sure at this point if the code or the documentation is wrong.
    The TArray documentation is out of date - TSet and TMap can now be tagged with UPROPERTY. We've made a JIRA to fix that. Thanks for pointing it out!

    Leave a comment:


  • commented on 's reply
    Thanks for reporting this issue. I'll pass this along to the appropriate contact here at Epic.

  • replied
    I was reading the Introduction to C++ page under the TSet heading (https://docs.unrealengine.com/en-US/...ndex.html#tset) and it states

    Remember that currently, the only container class that can be marked as a UPROPERTY is TArray. This means other container classes cannot be replicated, saved, or have their elements garbage collected for you.
    However, going through the Action RPG learning resource (https://www.unrealengine.com/marketplace/en-US/slug/action-rpg), I noticed this:

    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = Inventory)
    TMap<URPGItem*, FRPGItemData> InventoryData;
    I'm not sure at this point if the code or the documentation is wrong.

    Leave a comment:


  • commented on 's reply
    This issue should be fixed now. You may have to force the page to reload (Ctrl+F5 or Shift+F5) to get it to update though.

  • commented on 's reply
    This must have slipped through. I will get it fixed ASAP.

  • replied
    Didn't find better place to repport that, but it seems that the Documentation for BlueprintAPI, on google Chrome windows 10, has an error code turning into an infinite loop loading CPU usage. https://docs.unrealengine.com/en-US/...API/index.html
    All of its children seems to suffer that issue too, I can't test further cause it hurts my hardware way too much.

    Leave a comment:

Working...
X