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

Update docs #359

Merged
merged 27 commits into from
Apr 22, 2019
Merged

Update docs #359

merged 27 commits into from
Apr 22, 2019

Conversation

Affonso-Gui
Copy link
Member

This ended up with more changes than I thought, but the main objectives are to:

  • Use lispy expressions in lambda-list doc (which should be more natural).
    For example, transform (arg1 [arg2]) into (arg1 &optional arg2)

  • Lint newlines and bracket positions in functions descriptions to the following form

\funcdesc{name}{args}{
description.}
  • Unify some points that were different between english and japanese documentation (such as variables names, order of appearance, etc)

@Affonso-Gui
Copy link
Member Author

NOTE: work in progress, do not merge yet.

@Affonso-Gui Affonso-Gui changed the base branch from cl-compatible to master April 22, 2019 04:59
@k-okada k-okada merged commit 3dc7771 into euslisp:master Apr 22, 2019
k-okada added a commit to k-okada/jskeus that referenced this pull request Jun 6, 2019
euslisp/EusLisp@b6a25e9#diff-95f8abe64beb6e0fc27b68349ac0cac7 in euslisp/EusLisp#359 changed definition of longdescription in EusLisp and we need to update this for jmanual.tex in jskeus too
k-okada added a commit to k-okada/EusLisp that referenced this pull request Jun 6, 2019
euslisp@b6a25e9#diff-95f8abe64beb6e0fc27b68349ac0cac7 in euslisp#359 changed the definition of longdescription and we need to update documentation.l (which is only used in jskeus for now) too

Cc: @Affonso-Gui
k-okada added a commit to k-okada/jskeus that referenced this pull request Jun 6, 2019
euslisp/EusLisp@b6a25e9#diff-95f8abe64beb6e0fc27b68349ac0cac7 in euslisp/EusLisp#359 changed definition of longdescription in EusLisp and we need to update this for jmanual.tex in jskeus too
@Affonso-Gui Affonso-Gui deleted the update-docs branch January 31, 2020 04:44
This was referenced Jan 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants