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

Improve documentation #1676

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve documentation #1676

wants to merge 2 commits into from

Conversation

omalyshe
Copy link
Contributor

Description

Update some documentation topics.

Fixes # - issue number(s) if exists

Type of change

Choose one or multiple, leave empty if none of the other choices apply

Add a respective label(s) to PR if you have permissions

  • bug fix - change that fixes an issue
  • new feature - change that adds functionality
  • tests - change in tests
  • infrastructure - change in infrastructure and CI
  • documentation - documentation update

Tests

  • added - required for new features and some bug fixes
  • not needed

Documentation

  • updated in # - add PR number
  • needs to be updated
  • not needed

Breaks backward compatibility

  • Yes
  • No
  • Unknown

Notify the following users

List users with @ to send notifications

Other information

- | ``LIBRARY_PATH``
| ``LD_LIBRARY_PATH``
* - Symbolic links
Copy link
Contributor

Choose a reason for hiding this comment

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

bulleted items are not aligned therefore the table cannot be built

- | ``LIBRARY_PATH``
| ``DYLD_LIBRARY_PATH``
* - Symbolic links
- | ``<tbb_install_dir>/lib/<lib><variant>.dylib`` -> ``<tbb_install_dir>lib/<lib><variant>.<ver_major>.dylib``
Copy link
Contributor

Choose a reason for hiding this comment

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

what is -> for?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"->" means that the left part is a link to the right part.

Sign up for free to 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