File: rename_workspace.txt

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (52 lines) | stat: -rw-r--r-- 1,291 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

renameWorkspace( oldName, newName )
    Renames a workspace.

    The new workspace name must not already exist. The only exception is when
    the old name and the new name are the same; in which case, invoking this
    function is a non-operation.

    As a 'base' workspace must always exist, when renaming the 'base' workspace,
    variables from the 'base' workspace are simply copied to a new workspace and
    the 'base' workspace cleared of user-defined variables.

    Parameters
    ----------
    oldName: string
        Name of workspace to rename.

    newName: string
        New workspace name.

    Examples
    --------
    // Create a new workspace:
    > workspace( 'foobar' );
    > var x = 3.14;

    // List current workspaces:
    > workspaces()

    // Switch to another workspace:
    > workspace( 'barfoo' );

    // List current workspaces:
    > workspaces()

    // Rename the first workspace:
    > renameWorkspace( 'foobar', 'beepboop' );

    // Check the updated list of workspaces:
    > workspaces()

    // Switch to the renamed workspace:
    > workspace( 'beepboop' );

    // Confirm that workspace contains previously defined variables:
    > x


    See Also
    --------
    currentWorkspace, deleteWorkspace, loadWorkspace, workspace, workspaces