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

Bug: Referenced documents, "ai_data" and "Post processing", missing #5814

Open
MarkCallow opened this issue Oct 12, 2024 · 0 comments
Open
Labels
Bug Global flag to mark a deviation from expected behaviour

Comments

@MarkCallow
Copy link

Describe the bug
The document at https://assimp-docs.readthedocs.io/en/latest/usage/use_the_lib.html refers to documents that describe the imported data and available post processing steps. The doc. contains no links and a web search fails to find these documents.

There are other similar non-functional references.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://assimp-docs.readthedocs.io/en/latest/usage/use_the_lib.html
  2. Scroll down to just below the box with the C++ example.
  3. Observe this text:
    "What exactly is read from the files and how you interpret it is described at the:ref:ai_data. The post-processing steps that the Assimp library can apply to the imported data are listed at #aiPostProcessSteps. See the @ref pp Post processing page for more details."
  4. Notice that the references are not links.
  5. Try to find the referenced docs in the table of contents or via a web search.
  6. Fail.

Expected behavior
I expect the references to be links to the reference documents. I also expect to be able to find said docs with a web search.

Screenshots
n/a

Platform (please complete the following information):

  • OS: macOS
  • Browser Firefox
  • Version [131.0]

Additional context
I need these documents to find out what to expected for the coordinate system and winding of the imported data and to see what post-processing may be available to convert to the desired coordinate system.

@MarkCallow MarkCallow added the Bug Global flag to mark a deviation from expected behaviour label Oct 12, 2024
@MarkCallow MarkCallow changed the title Bug: Referenced documents, "ai_data" and "Post processing" missing Bug: Referenced documents, "ai_data" and "Post processing", missing Oct 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Global flag to mark a deviation from expected behaviour
Projects
None yet
Development

No branches or pull requests

1 participant