Stats

  • Locked Locked
  • Replies 2
  • Subscribers 143
  • Views 13397
  • Members are here 0
This discussion has been locked.
You can no longer post new replies to this discussion. If you have a question you can start a new discussion

How to add help for my procedure?

dell1

I need to add a help option for my own defined procedure such that when the user write "help(proc_name)" he gets the inputs definition and expected output.

Parents
  • skillUser

    Hi Dell1,

    The way to do this is to add your own documentation to the cdsFinder database. The location and format is covered in the Finder documentation in the Cadence SKILL Development Help manual.  Here's a brief excerpt:

    For example, if you add your functions to

    your_install_dir/local/finder/SKILL/Your_APIs/your.fnd

    the following string appears in the Searching cyclic field:

    Your APIs Only

     

    You can set the CDS_FINDER_PATH environment variable to add locations for the tool to look at.  When you use the "help" function you may notice that it reports: "Consulting cdsFinder database (may take a while) ...", so this applies to both the cdsFinder stand alone tool as well as the "help" function.

    Hope this helps!

    Lawrence.

Reply
  • skillUser

    Hi Dell1,

    The way to do this is to add your own documentation to the cdsFinder database. The location and format is covered in the Finder documentation in the Cadence SKILL Development Help manual.  Here's a brief excerpt:

    For example, if you add your functions to

    your_install_dir/local/finder/SKILL/Your_APIs/your.fnd

    the following string appears in the Searching cyclic field:

    Your APIs Only

     

    You can set the CDS_FINDER_PATH environment variable to add locations for the tool to look at.  When you use the "help" function you may notice that it reports: "Consulting cdsFinder database (may take a while) ...", so this applies to both the cdsFinder stand alone tool as well as the "help" function.

    Hope this helps!

    Lawrence.

Children
No Data

Community Guidelines

The Cadence Design Communities support Cadence users and technologists interacting to exchange ideas, news, technical information, and best practices to solve problems and get the most from Cadence technology. The community is open to everyone, and to provide the most value, we require participants to follow our Community Guidelines that facilitate a quality exchange of ideas and information. By accessing, contributing, using or downloading any materials from the site, you agree to be bound by the full Community Guidelines.